<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.10"/>
<title>iicps: Iicps_v3_0</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">iicps
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Iicps_v3_0</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_iic_ps___config.html">XIicPs_Config</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_iic_ps.html">XIicPs</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gabcc20fce80c1e8dff27be4e584c2cc27"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#gabcc20fce80c1e8dff27be4e584c2cc27">XIicPs_ReadReg</a>(BaseAddress,  RegOffset)&#160;&#160;&#160;XIicPs_In32((BaseAddress) + (u32)(RegOffset))</td></tr>
<tr class="separator:gabcc20fce80c1e8dff27be4e584c2cc27"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa0bde6894589023ea8248a9d9cdc73c5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#gaa0bde6894589023ea8248a9d9cdc73c5">XIicPs_WriteReg</a>(BaseAddress,  RegOffset,  RegisterValue)&#160;&#160;&#160;XIicPs_Out32((BaseAddress) + (u32)(RegOffset), (u32)(RegisterValue))</td></tr>
<tr class="separator:gaa0bde6894589023ea8248a9d9cdc73c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab8f0f78d7389924d17d2b7b49f622cf1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#gab8f0f78d7389924d17d2b7b49f622cf1">XIicPs_ReadIER</a>(BaseAddress)&#160;&#160;&#160;<a class="el" href="group__iicps__v3__0.html#gabcc20fce80c1e8dff27be4e584c2cc27">XIicPs_ReadReg</a>((BaseAddress),  <a class="el" href="group__iicps__v3__0.html#ga471cbaf2444941e33de173ea5e5c7f03">XIICPS_IER_OFFSET</a>)</td></tr>
<tr class="separator:gab8f0f78d7389924d17d2b7b49f622cf1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf7a3f4b57fe275f426ac9b771b187b23"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#gaf7a3f4b57fe275f426ac9b771b187b23">XIicPs_EnableInterrupts</a>(BaseAddress,  IntrMask)&#160;&#160;&#160;<a class="el" href="group__iicps__v3__0.html#gaa0bde6894589023ea8248a9d9cdc73c5">XIicPs_WriteReg</a>((BaseAddress), <a class="el" href="group__iicps__v3__0.html#ga471cbaf2444941e33de173ea5e5c7f03">XIICPS_IER_OFFSET</a>, (IntrMask))</td></tr>
<tr class="separator:gaf7a3f4b57fe275f426ac9b771b187b23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga90efda2a784d4b972f1835b0ba81cde1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga90efda2a784d4b972f1835b0ba81cde1">XIicPs_DisableAllInterrupts</a>(BaseAddress)</td></tr>
<tr class="separator:ga90efda2a784d4b972f1835b0ba81cde1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6a21536b3361fa36f00745a3e653fbbd"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga6a21536b3361fa36f00745a3e653fbbd">XIicPs_DisableInterrupts</a>(BaseAddress,  IntrMask)</td></tr>
<tr class="separator:ga6a21536b3361fa36f00745a3e653fbbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gabfedbe03a6ac7de3d4e0ac192b8ab288"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#gabfedbe03a6ac7de3d4e0ac192b8ab288">XIicPs_ResetHw</a> (u32 BaseAddress)</td></tr>
<tr class="separator:gabfedbe03a6ac7de3d4e0ac192b8ab288"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Role constants</h2></td></tr>
<tr><td class="ititle" colspan="2"><p><a class="anchor" id="amgrp9bbef19594e2bb00213beebd85d0861a"></a>These constants are used to pass into the device setup routines to set up the device according to transfer direction. </p>
</td></tr>
<tr class="memitem:gaabcfd3b5d9ed949a553a992242237cba"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#gaabcfd3b5d9ed949a553a992242237cba">XIicPs_IntrHandler</a>) (void *CallBackRef, u32 StatusEvent)</td></tr>
<tr class="separator:gaabcfd3b5d9ed949a553a992242237cba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae97ad9c202953c7e49bfb56533c47079"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#gae97ad9c202953c7e49bfb56533c47079">XIicPs_CfgInitialize</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr, <a class="el" href="struct_x_iic_ps___config.html">XIicPs_Config</a> *ConfigPtr, u32 EffectiveAddr)</td></tr>
<tr class="separator:gae97ad9c202953c7e49bfb56533c47079"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5b67ad96b8c40bdd47c2c2f8a57f170c"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga5b67ad96b8c40bdd47c2c2f8a57f170c">XIicPs_BusIsBusy</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr)</td></tr>
<tr class="separator:ga5b67ad96b8c40bdd47c2c2f8a57f170c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3eaa694ecd774beca05bf79c1f9df6c0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga3eaa694ecd774beca05bf79c1f9df6c0">XIicPs_Abort</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr)</td></tr>
<tr class="separator:ga3eaa694ecd774beca05bf79c1f9df6c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1169a92eb8594d6f038816b5740916f7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga1169a92eb8594d6f038816b5740916f7">XIicPs_Reset</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr)</td></tr>
<tr class="separator:ga1169a92eb8594d6f038816b5740916f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacfb0d8f18f8105db7708669ddb186e19"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#gacfb0d8f18f8105db7708669ddb186e19">TransmitFifoFill</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr)</td></tr>
<tr class="separator:gacfb0d8f18f8105db7708669ddb186e19"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga14c7ff4f51185d8aab0028c0eeb3c336"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_iic_ps___config.html">XIicPs_Config</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga14c7ff4f51185d8aab0028c0eeb3c336">XIicPs_LookupConfig</a> (u16 DeviceId)</td></tr>
<tr class="separator:ga14c7ff4f51185d8aab0028c0eeb3c336"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab2581047e7d5607fe96fe0dac9673527"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#gab2581047e7d5607fe96fe0dac9673527">XIicPs_SetStatusHandler</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr, void *CallBackRef, <a class="el" href="group__iicps__v3__0.html#gaabcfd3b5d9ed949a553a992242237cba">XIicPs_IntrHandler</a> FunctionPtr)</td></tr>
<tr class="separator:gab2581047e7d5607fe96fe0dac9673527"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3027c1eb6ece3193a978a2da8e06c011"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga3027c1eb6ece3193a978a2da8e06c011">XIicPs_MasterSend</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr, u8 *MsgPtr, s32 ByteCount, u16 SlaveAddr)</td></tr>
<tr class="separator:ga3027c1eb6ece3193a978a2da8e06c011"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4817f45c28341cea4ab8960dc1203acb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga4817f45c28341cea4ab8960dc1203acb">XIicPs_MasterRecv</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr, u8 *MsgPtr, s32 ByteCount, u16 SlaveAddr)</td></tr>
<tr class="separator:ga4817f45c28341cea4ab8960dc1203acb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga71584f1a7e675cde41cfd9d1bd4320b4"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga71584f1a7e675cde41cfd9d1bd4320b4">XIicPs_MasterSendPolled</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr, u8 *MsgPtr, s32 ByteCount, u16 SlaveAddr)</td></tr>
<tr class="separator:ga71584f1a7e675cde41cfd9d1bd4320b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga21bdb2f8a1f09e027aa8b0e9d6648d75"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga21bdb2f8a1f09e027aa8b0e9d6648d75">XIicPs_MasterRecvPolled</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr, u8 *MsgPtr, s32 ByteCount, u16 SlaveAddr)</td></tr>
<tr class="separator:ga21bdb2f8a1f09e027aa8b0e9d6648d75"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga597faa64ccaf3d8034e3e92989048f06"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga597faa64ccaf3d8034e3e92989048f06">XIicPs_EnableSlaveMonitor</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr, u16 SlaveAddr)</td></tr>
<tr class="separator:ga597faa64ccaf3d8034e3e92989048f06"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga15f2e8071ff8d8e1ec1dc56d29ab202b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga15f2e8071ff8d8e1ec1dc56d29ab202b">XIicPs_DisableSlaveMonitor</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr)</td></tr>
<tr class="separator:ga15f2e8071ff8d8e1ec1dc56d29ab202b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad64f0389aa694ecf21ca8a39e44cf13f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#gad64f0389aa694ecf21ca8a39e44cf13f">XIicPs_MasterInterruptHandler</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr)</td></tr>
<tr class="separator:gad64f0389aa694ecf21ca8a39e44cf13f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad1c7ffa09df93fb59f97b0a3bf5baaa7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#gad1c7ffa09df93fb59f97b0a3bf5baaa7">XIicPs_SetupSlave</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr, u16 SlaveAddr)</td></tr>
<tr class="separator:gad1c7ffa09df93fb59f97b0a3bf5baaa7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4478d1d94f349deda02c0191a7529113"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga4478d1d94f349deda02c0191a7529113">XIicPs_SlaveSend</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr, u8 *MsgPtr, s32 ByteCount)</td></tr>
<tr class="separator:ga4478d1d94f349deda02c0191a7529113"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1840936a940459c5a71858f94915f933"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga1840936a940459c5a71858f94915f933">XIicPs_SlaveRecv</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr, u8 *MsgPtr, s32 ByteCount)</td></tr>
<tr class="separator:ga1840936a940459c5a71858f94915f933"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5ca49d9131b13d66f58de0b5a23faea4"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga5ca49d9131b13d66f58de0b5a23faea4">XIicPs_SlaveSendPolled</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr, u8 *MsgPtr, s32 ByteCount)</td></tr>
<tr class="separator:ga5ca49d9131b13d66f58de0b5a23faea4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga74b0af9e4395c8de724dc377e3504d0d"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga74b0af9e4395c8de724dc377e3504d0d">XIicPs_SlaveRecvPolled</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr, u8 *MsgPtr, s32 ByteCount)</td></tr>
<tr class="separator:ga74b0af9e4395c8de724dc377e3504d0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga716cdb9f63e56269824866872958dd78"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga716cdb9f63e56269824866872958dd78">XIicPs_SlaveInterruptHandler</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr)</td></tr>
<tr class="separator:ga716cdb9f63e56269824866872958dd78"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6f9db7651cd6ee0232dc9fdaca3f976a"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga6f9db7651cd6ee0232dc9fdaca3f976a">XIicPs_SelfTest</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr)</td></tr>
<tr class="separator:ga6f9db7651cd6ee0232dc9fdaca3f976a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaec1dc5be2be8a7394263cfe56af976c5"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#gaec1dc5be2be8a7394263cfe56af976c5">XIicPs_SetOptions</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr, u32 Options)</td></tr>
<tr class="separator:gaec1dc5be2be8a7394263cfe56af976c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga87cbf2622a9c6ad66b18d4c3f9575a76"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga87cbf2622a9c6ad66b18d4c3f9575a76">XIicPs_ClearOptions</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr, u32 Options)</td></tr>
<tr class="separator:ga87cbf2622a9c6ad66b18d4c3f9575a76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga20964e35a74f4e16f90e78510c9b4337"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga20964e35a74f4e16f90e78510c9b4337">XIicPs_GetOptions</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr)</td></tr>
<tr class="separator:ga20964e35a74f4e16f90e78510c9b4337"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafb24cfdacf6cf28d80126862dc1cfbe5"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#gafb24cfdacf6cf28d80126862dc1cfbe5">XIicPs_SetSClk</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr, u32 FsclHz)</td></tr>
<tr class="separator:gafb24cfdacf6cf28d80126862dc1cfbe5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9f2d2d3d11c2c9125a5bc8a0d95593cb"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga9f2d2d3d11c2c9125a5bc8a0d95593cb">XIicPs_GetSClk</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr)</td></tr>
<tr class="separator:ga9f2d2d3d11c2c9125a5bc8a0d95593cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga9cfa5c76753b0658954c2c3dfec95d40"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define RECVING_ROLE&#160;&#160;&#160;0</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8h.html">xiicps.h</a>&gt;</code></p>

<p>Transfer direction is receiving. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#ga4817f45c28341cea4ab8960dc1203acb">XIicPs_MasterRecv()</a>, and <a class="el" href="group__iicps__v3__0.html#ga21bdb2f8a1f09e027aa8b0e9d6648d75">XIicPs_MasterRecvPolled()</a>.</p>

</div>
</div>
<a class="anchor" id="ga80e3362dd68172d429bb9361768d09e7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define SENDING_ROLE&#160;&#160;&#160;1</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8h.html">xiicps.h</a>&gt;</code></p>

<p>Transfer direction is sending. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#ga3027c1eb6ece3193a978a2da8e06c011">XIicPs_MasterSend()</a>, and <a class="el" href="group__iicps__v3__0.html#ga71584f1a7e675cde41cfd9d1bd4320b4">XIicPs_MasterSendPolled()</a>.</p>

</div>
</div>
<a class="anchor" id="ga4057e55c42ab0d06b32c55d5e67e0029"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_10_BIT_ADDR_OPTION&#160;&#160;&#160;0x02U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8h.html">xiicps.h</a>&gt;</code></p>

<p>10-bit address mode </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#ga87cbf2622a9c6ad66b18d4c3f9575a76">XIicPs_ClearOptions()</a>, <a class="el" href="group__iicps__v3__0.html#ga20964e35a74f4e16f90e78510c9b4337">XIicPs_GetOptions()</a>, and <a class="el" href="group__iicps__v3__0.html#gaec1dc5be2be8a7394263cfe56af976c5">XIicPs_SetOptions()</a>.</p>

</div>
</div>
<a class="anchor" id="gabaf93558635651b401ca9404cc777d73"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_7_BIT_ADDR_OPTION&#160;&#160;&#160;0x01U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8h.html">xiicps.h</a>&gt;</code></p>

<p>7-bit address mode </p>

</div>
</div>
<a class="anchor" id="ga65d613d28fe2707d6e1d0fb2ea5b0d9e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_ADDR_MASK&#160;&#160;&#160;0x000003FF</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>IIC Address Mask. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#ga4817f45c28341cea4ab8960dc1203acb">XIicPs_MasterRecv()</a>, <a class="el" href="group__iicps__v3__0.html#ga21bdb2f8a1f09e027aa8b0e9d6648d75">XIicPs_MasterRecvPolled()</a>, <a class="el" href="group__iicps__v3__0.html#ga3027c1eb6ece3193a978a2da8e06c011">XIicPs_MasterSend()</a>, <a class="el" href="group__iicps__v3__0.html#ga71584f1a7e675cde41cfd9d1bd4320b4">XIicPs_MasterSendPolled()</a>, and <a class="el" href="group__iicps__v3__0.html#gad1c7ffa09df93fb59f97b0a3bf5baaa7">XIicPs_SetupSlave()</a>.</p>

</div>
</div>
<a class="anchor" id="ga3d97551edd7013b07093cac16dbe80f1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_ADDR_OFFSET&#160;&#160;&#160;0x08U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>IIC Address. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#ga597faa64ccaf3d8034e3e92989048f06">XIicPs_EnableSlaveMonitor()</a>, <a class="el" href="group__iicps__v3__0.html#gad64f0389aa694ecf21ca8a39e44cf13f">XIicPs_MasterInterruptHandler()</a>, <a class="el" href="group__iicps__v3__0.html#ga4817f45c28341cea4ab8960dc1203acb">XIicPs_MasterRecv()</a>, <a class="el" href="group__iicps__v3__0.html#ga21bdb2f8a1f09e027aa8b0e9d6648d75">XIicPs_MasterRecvPolled()</a>, <a class="el" href="group__iicps__v3__0.html#ga3027c1eb6ece3193a978a2da8e06c011">XIicPs_MasterSend()</a>, <a class="el" href="group__iicps__v3__0.html#ga71584f1a7e675cde41cfd9d1bd4320b4">XIicPs_MasterSendPolled()</a>, and <a class="el" href="group__iicps__v3__0.html#gad1c7ffa09df93fb59f97b0a3bf5baaa7">XIicPs_SetupSlave()</a>.</p>

</div>
</div>
<a class="anchor" id="ga8eca5ebddd70579d4ecc3af1df21f4bf"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_CR_ACKEN_MASK&#160;&#160;&#160;0x00000008U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Enable TX of ACK when Master receiver. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#gabfedbe03a6ac7de3d4e0ac192b8ab288">XIicPs_ResetHw()</a>, and <a class="el" href="group__iicps__v3__0.html#gad1c7ffa09df93fb59f97b0a3bf5baaa7">XIicPs_SetupSlave()</a>.</p>

</div>
</div>
<a class="anchor" id="ga167d2a48ba5ab4cdf58f229bf6a0b554"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_CR_CLR_FIFO_MASK&#160;&#160;&#160;0x00000040U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Clear FIFO, auto clears. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#ga3eaa694ecd774beca05bf79c1f9df6c0">XIicPs_Abort()</a>, <a class="el" href="group__iicps__v3__0.html#ga597faa64ccaf3d8034e3e92989048f06">XIicPs_EnableSlaveMonitor()</a>, <a class="el" href="group__iicps__v3__0.html#gabfedbe03a6ac7de3d4e0ac192b8ab288">XIicPs_ResetHw()</a>, and <a class="el" href="group__iicps__v3__0.html#gad1c7ffa09df93fb59f97b0a3bf5baaa7">XIicPs_SetupSlave()</a>.</p>

</div>
</div>
<a class="anchor" id="gae1eb58bcf8d77fd6a8f9325d5344b390"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_CR_DIV_A_MASK&#160;&#160;&#160;0x0000C000U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Clock Divisor A. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#ga9f2d2d3d11c2c9125a5bc8a0d95593cb">XIicPs_GetSClk()</a>, and <a class="el" href="group__iicps__v3__0.html#gafb24cfdacf6cf28d80126862dc1cfbe5">XIicPs_SetSClk()</a>.</p>

</div>
</div>
<a class="anchor" id="gae980b732a8b41e97461d097cdca82d38"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_CR_DIV_A_SHIFT&#160;&#160;&#160;14U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Clock Divisor A shift. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#ga9f2d2d3d11c2c9125a5bc8a0d95593cb">XIicPs_GetSClk()</a>, and <a class="el" href="group__iicps__v3__0.html#gafb24cfdacf6cf28d80126862dc1cfbe5">XIicPs_SetSClk()</a>.</p>

</div>
</div>
<a class="anchor" id="gaee06a0e2ceece45ef3ca15fffacbaac3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_CR_DIV_B_MASK&#160;&#160;&#160;0x00003F00U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Clock Divisor B. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#ga9f2d2d3d11c2c9125a5bc8a0d95593cb">XIicPs_GetSClk()</a>, and <a class="el" href="group__iicps__v3__0.html#gafb24cfdacf6cf28d80126862dc1cfbe5">XIicPs_SetSClk()</a>.</p>

</div>
</div>
<a class="anchor" id="ga0475ff513956035cd712dd4ee3301364"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_CR_DIV_B_SHIFT&#160;&#160;&#160;8U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Clock Divisor B shift. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#ga9f2d2d3d11c2c9125a5bc8a0d95593cb">XIicPs_GetSClk()</a>, and <a class="el" href="group__iicps__v3__0.html#gafb24cfdacf6cf28d80126862dc1cfbe5">XIicPs_SetSClk()</a>.</p>

</div>
</div>
<a class="anchor" id="ga11283b281c133a5b15d4da9ce99fa44e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_CR_HOLD_MASK&#160;&#160;&#160;0x00000010U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Hold bus 1=Hold scl, 0=terminate transfer. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#gad64f0389aa694ecf21ca8a39e44cf13f">XIicPs_MasterInterruptHandler()</a>, <a class="el" href="group__iicps__v3__0.html#ga4817f45c28341cea4ab8960dc1203acb">XIicPs_MasterRecv()</a>, <a class="el" href="group__iicps__v3__0.html#ga21bdb2f8a1f09e027aa8b0e9d6648d75">XIicPs_MasterRecvPolled()</a>, <a class="el" href="group__iicps__v3__0.html#ga3027c1eb6ece3193a978a2da8e06c011">XIicPs_MasterSend()</a>, <a class="el" href="group__iicps__v3__0.html#ga71584f1a7e675cde41cfd9d1bd4320b4">XIicPs_MasterSendPolled()</a>, and <a class="el" href="group__iicps__v3__0.html#gabfedbe03a6ac7de3d4e0ac192b8ab288">XIicPs_ResetHw()</a>.</p>

</div>
</div>
<a class="anchor" id="ga77c04588069ca5f72be4e8177ff6c0d8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_CR_MS_MASK&#160;&#160;&#160;0x00000002U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Master mode bit 1=Master, 0=Slave. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#ga597faa64ccaf3d8034e3e92989048f06">XIicPs_EnableSlaveMonitor()</a>, <a class="el" href="group__iicps__v3__0.html#gabfedbe03a6ac7de3d4e0ac192b8ab288">XIicPs_ResetHw()</a>, and <a class="el" href="group__iicps__v3__0.html#gad1c7ffa09df93fb59f97b0a3bf5baaa7">XIicPs_SetupSlave()</a>.</p>

</div>
</div>
<a class="anchor" id="gada95425b2ab9cb404dcdc418d667370c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_CR_NEA_MASK&#160;&#160;&#160;0x00000004U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Addressing Mode 1=7 bit, 0=10 bit. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#ga597faa64ccaf3d8034e3e92989048f06">XIicPs_EnableSlaveMonitor()</a>, <a class="el" href="group__iicps__v3__0.html#ga20964e35a74f4e16f90e78510c9b4337">XIicPs_GetOptions()</a>, and <a class="el" href="group__iicps__v3__0.html#gad1c7ffa09df93fb59f97b0a3bf5baaa7">XIicPs_SetupSlave()</a>.</p>

</div>
</div>
<a class="anchor" id="ga0c96ab97015c857822df599608ba9c10"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_CR_OFFSET&#160;&#160;&#160;0x00U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>32-bit Control </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#ga3eaa694ecd774beca05bf79c1f9df6c0">XIicPs_Abort()</a>, <a class="el" href="group__iicps__v3__0.html#ga87cbf2622a9c6ad66b18d4c3f9575a76">XIicPs_ClearOptions()</a>, <a class="el" href="group__iicps__v3__0.html#ga15f2e8071ff8d8e1ec1dc56d29ab202b">XIicPs_DisableSlaveMonitor()</a>, <a class="el" href="group__iicps__v3__0.html#ga597faa64ccaf3d8034e3e92989048f06">XIicPs_EnableSlaveMonitor()</a>, <a class="el" href="group__iicps__v3__0.html#ga20964e35a74f4e16f90e78510c9b4337">XIicPs_GetOptions()</a>, <a class="el" href="group__iicps__v3__0.html#ga9f2d2d3d11c2c9125a5bc8a0d95593cb">XIicPs_GetSClk()</a>, <a class="el" href="group__iicps__v3__0.html#gad64f0389aa694ecf21ca8a39e44cf13f">XIicPs_MasterInterruptHandler()</a>, <a class="el" href="group__iicps__v3__0.html#ga4817f45c28341cea4ab8960dc1203acb">XIicPs_MasterRecv()</a>, <a class="el" href="group__iicps__v3__0.html#ga21bdb2f8a1f09e027aa8b0e9d6648d75">XIicPs_MasterRecvPolled()</a>, <a class="el" href="group__iicps__v3__0.html#ga3027c1eb6ece3193a978a2da8e06c011">XIicPs_MasterSend()</a>, <a class="el" href="group__iicps__v3__0.html#ga71584f1a7e675cde41cfd9d1bd4320b4">XIicPs_MasterSendPolled()</a>, <a class="el" href="group__iicps__v3__0.html#ga1169a92eb8594d6f038816b5740916f7">XIicPs_Reset()</a>, <a class="el" href="group__iicps__v3__0.html#gabfedbe03a6ac7de3d4e0ac192b8ab288">XIicPs_ResetHw()</a>, <a class="el" href="group__iicps__v3__0.html#ga6f9db7651cd6ee0232dc9fdaca3f976a">XIicPs_SelfTest()</a>, <a class="el" href="group__iicps__v3__0.html#gaec1dc5be2be8a7394263cfe56af976c5">XIicPs_SetOptions()</a>, <a class="el" href="group__iicps__v3__0.html#gafb24cfdacf6cf28d80126862dc1cfbe5">XIicPs_SetSClk()</a>, and <a class="el" href="group__iicps__v3__0.html#gad1c7ffa09df93fb59f97b0a3bf5baaa7">XIicPs_SetupSlave()</a>.</p>

</div>
</div>
<a class="anchor" id="gad8c3988f9bb22c7d3f2ce88f6a7f0aa0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_CR_RD_WR_MASK&#160;&#160;&#160;0x00000001U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Read or Write Master transfer 0=Transmitter, 1=Receiver. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#ga597faa64ccaf3d8034e3e92989048f06">XIicPs_EnableSlaveMonitor()</a>.</p>

</div>
</div>
<a class="anchor" id="ga42b856fa59af3400a93291cf0e652307"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_CR_RESET_VALUE&#160;&#160;&#160;0U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Reset value of the Control register. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#ga3eaa694ecd774beca05bf79c1f9df6c0">XIicPs_Abort()</a>, <a class="el" href="group__iicps__v3__0.html#ga1169a92eb8594d6f038816b5740916f7">XIicPs_Reset()</a>, and <a class="el" href="group__iicps__v3__0.html#ga6f9db7651cd6ee0232dc9fdaca3f976a">XIicPs_SelfTest()</a>.</p>

</div>
</div>
<a class="anchor" id="gade5ece1da092340afd300afe0387f207"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_CR_SLVMON_MASK&#160;&#160;&#160;0x00000020U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Slave monitor mode. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#ga15f2e8071ff8d8e1ec1dc56d29ab202b">XIicPs_DisableSlaveMonitor()</a>, and <a class="el" href="group__iicps__v3__0.html#ga597faa64ccaf3d8034e3e92989048f06">XIicPs_EnableSlaveMonitor()</a>.</p>

</div>
</div>
<a class="anchor" id="gaaf1867a207f808f18a373435dee8f525"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_DATA_INTR_DEPTH&#160;&#160;&#160;14</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Number of bytes at DATA intr. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#gad64f0389aa694ecf21ca8a39e44cf13f">XIicPs_MasterInterruptHandler()</a>, and <a class="el" href="group__iicps__v3__0.html#ga21bdb2f8a1f09e027aa8b0e9d6648d75">XIicPs_MasterRecvPolled()</a>.</p>

</div>
</div>
<a class="anchor" id="ga324b3ca19000b5cc8944daf85c8f7736"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_DATA_MASK&#160;&#160;&#160;0x000000FF</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>IIC Data Mask. </p>

</div>
</div>
<a class="anchor" id="gac9101ca416d8b9e303b4a65c4840a1d5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_DATA_OFFSET&#160;&#160;&#160;0x0CU</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>IIC FIFO Data. </p>

</div>
</div>
<a class="anchor" id="ga90efda2a784d4b972f1835b0ba81cde1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIicPs_DisableAllInterrupts</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">BaseAddress</td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>
<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="group__iicps__v3__0.html#gaa0bde6894589023ea8248a9d9cdc73c5">XIicPs_WriteReg</a>((BaseAddress), <a class="code" href="group__iicps__v3__0.html#gac95b4e2bd04257b322e5bf66f956bdf3">XIICPS_IDR_OFFSET</a>, \</div>
<div class="line">                <a class="code" href="group__iicps__v3__0.html#ga8e324637da3483d518d499b7257c7631">XIICPS_IXR_ALL_INTR_MASK</a>)</div>
<div class="ttc" id="group__iicps__v3__0_html_gac95b4e2bd04257b322e5bf66f956bdf3"><div class="ttname"><a href="group__iicps__v3__0.html#gac95b4e2bd04257b322e5bf66f956bdf3">XIICPS_IDR_OFFSET</a></div><div class="ttdeci">#define XIICPS_IDR_OFFSET</div><div class="ttdoc">Interrupt Disable. </div><div class="ttdef"><b>Definition:</b> xiicps_hw.h:85</div></div>
<div class="ttc" id="group__iicps__v3__0_html_ga8e324637da3483d518d499b7257c7631"><div class="ttname"><a href="group__iicps__v3__0.html#ga8e324637da3483d518d499b7257c7631">XIICPS_IXR_ALL_INTR_MASK</a></div><div class="ttdeci">#define XIICPS_IXR_ALL_INTR_MASK</div><div class="ttdoc">All ISR Mask. </div><div class="ttdef"><b>Definition:</b> xiicps_hw.h:216</div></div>
<div class="ttc" id="group__iicps__v3__0_html_gaa0bde6894589023ea8248a9d9cdc73c5"><div class="ttname"><a href="group__iicps__v3__0.html#gaa0bde6894589023ea8248a9d9cdc73c5">XIicPs_WriteReg</a></div><div class="ttdeci">#define XIicPs_WriteReg(BaseAddress, RegOffset, RegisterValue)</div><div class="ttdoc">Write an IIC register. </div><div class="ttdef"><b>Definition:</b> xiicps_hw.h:316</div></div>
</div><!-- fragment -->
<p>Disable all interrupts. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BaseAddress</td><td>contains the base address of the device.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-Style signature: void <a class="el" href="group__iicps__v3__0.html#ga90efda2a784d4b972f1835b0ba81cde1" title="Disable all interrupts. ">XIicPs_DisableAllInterrupts(u32 BaseAddress)</a> </dd></dl>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#gad1c7ffa09df93fb59f97b0a3bf5baaa7">XIicPs_SetupSlave()</a>.</p>

</div>
</div>
<a class="anchor" id="ga6a21536b3361fa36f00745a3e653fbbd"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIicPs_DisableInterrupts</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">BaseAddress, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">IntrMask&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>
<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="group__iicps__v3__0.html#gaa0bde6894589023ea8248a9d9cdc73c5">XIicPs_WriteReg</a>((BaseAddress), <a class="code" href="group__iicps__v3__0.html#gac95b4e2bd04257b322e5bf66f956bdf3">XIICPS_IDR_OFFSET</a>, \</div>
<div class="line">                (IntrMask))</div>
<div class="ttc" id="group__iicps__v3__0_html_gac95b4e2bd04257b322e5bf66f956bdf3"><div class="ttname"><a href="group__iicps__v3__0.html#gac95b4e2bd04257b322e5bf66f956bdf3">XIICPS_IDR_OFFSET</a></div><div class="ttdeci">#define XIICPS_IDR_OFFSET</div><div class="ttdoc">Interrupt Disable. </div><div class="ttdef"><b>Definition:</b> xiicps_hw.h:85</div></div>
<div class="ttc" id="group__iicps__v3__0_html_gaa0bde6894589023ea8248a9d9cdc73c5"><div class="ttname"><a href="group__iicps__v3__0.html#gaa0bde6894589023ea8248a9d9cdc73c5">XIicPs_WriteReg</a></div><div class="ttdeci">#define XIicPs_WriteReg(BaseAddress, RegOffset, RegisterValue)</div><div class="ttdoc">Write an IIC register. </div><div class="ttdef"><b>Definition:</b> xiicps_hw.h:316</div></div>
</div><!-- fragment -->
<p>Disable selected interrupts. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BaseAddress</td><td>contains the base address of the device.</td></tr>
    <tr><td class="paramname">IntrMask</td><td>is the interrupts to be disabled.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-Style signature: void <a class="el" href="group__iicps__v3__0.html#ga6a21536b3361fa36f00745a3e653fbbd" title="Disable selected interrupts. ">XIicPs_DisableInterrupts(u32 BaseAddress, u32 IntrMask)</a> </dd></dl>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#ga15f2e8071ff8d8e1ec1dc56d29ab202b">XIicPs_DisableSlaveMonitor()</a>.</p>

</div>
</div>
<a class="anchor" id="gab87d93689afe5c24a5619083ea1f3ca9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_DIV_A_MAX&#160;&#160;&#160;4U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Maximum value of Divisor A. </p>

</div>
</div>
<a class="anchor" id="gaf7a3f4b57fe275f426ac9b771b187b23"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIicPs_EnableInterrupts</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">BaseAddress, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">IntrMask&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;<a class="el" href="group__iicps__v3__0.html#gaa0bde6894589023ea8248a9d9cdc73c5">XIicPs_WriteReg</a>((BaseAddress), <a class="el" href="group__iicps__v3__0.html#ga471cbaf2444941e33de173ea5e5c7f03">XIICPS_IER_OFFSET</a>, (IntrMask))</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Write to the interrupt enable register. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BaseAddress</td><td>contains the base address of the device.</td></tr>
    <tr><td class="paramname">IntrMask</td><td>is the interrupts to be enabled.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-Style signature: void XIicPs_EnabledInterrupts(u32 BaseAddress, u32 IntrMask) </dd></dl>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#ga597faa64ccaf3d8034e3e92989048f06">XIicPs_EnableSlaveMonitor()</a>, <a class="el" href="group__iicps__v3__0.html#gad64f0389aa694ecf21ca8a39e44cf13f">XIicPs_MasterInterruptHandler()</a>, <a class="el" href="group__iicps__v3__0.html#ga4817f45c28341cea4ab8960dc1203acb">XIicPs_MasterRecv()</a>, <a class="el" href="group__iicps__v3__0.html#ga3027c1eb6ece3193a978a2da8e06c011">XIicPs_MasterSend()</a>, <a class="el" href="group__iicps__v3__0.html#ga1840936a940459c5a71858f94915f933">XIicPs_SlaveRecv()</a>, and <a class="el" href="group__iicps__v3__0.html#ga4478d1d94f349deda02c0191a7529113">XIicPs_SlaveSend()</a>.</p>

</div>
</div>
<a class="anchor" id="gab784c2ba84387c6a91b0f279065bf396"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_EVENT_ARB_LOST&#160;&#160;&#160;0x0010U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8h.html">xiicps.h</a>&gt;</code></p>

<p>Arbitration lost. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#gad64f0389aa694ecf21ca8a39e44cf13f">XIicPs_MasterInterruptHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="ga6aa923029f051dc7a1f8db08cd8691ff"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_EVENT_COMPLETE_RECV&#160;&#160;&#160;0x0002U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8h.html">xiicps.h</a>&gt;</code></p>

<p>Receive Complete Event. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#gad64f0389aa694ecf21ca8a39e44cf13f">XIicPs_MasterInterruptHandler()</a>, and <a class="el" href="group__iicps__v3__0.html#ga716cdb9f63e56269824866872958dd78">XIicPs_SlaveInterruptHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="ga1646c08302f01007599cd95721006d35"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_EVENT_COMPLETE_SEND&#160;&#160;&#160;0x0001U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8h.html">xiicps.h</a>&gt;</code></p>

<p>Transmit Complete Event. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#gad64f0389aa694ecf21ca8a39e44cf13f">XIicPs_MasterInterruptHandler()</a>, and <a class="el" href="group__iicps__v3__0.html#ga716cdb9f63e56269824866872958dd78">XIicPs_SlaveInterruptHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="ga60331546be6cd538df23e7ca3e1789fa"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_EVENT_ERROR&#160;&#160;&#160;0x0008U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8h.html">xiicps.h</a>&gt;</code></p>

<p>Receive error. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#gad64f0389aa694ecf21ca8a39e44cf13f">XIicPs_MasterInterruptHandler()</a>, and <a class="el" href="group__iicps__v3__0.html#ga716cdb9f63e56269824866872958dd78">XIicPs_SlaveInterruptHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="gad72c8977f9bab033f2c393d24a70d5be"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_EVENT_NACK&#160;&#160;&#160;0x0020U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8h.html">xiicps.h</a>&gt;</code></p>

<p>NACK Received. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#gad64f0389aa694ecf21ca8a39e44cf13f">XIicPs_MasterInterruptHandler()</a>, and <a class="el" href="group__iicps__v3__0.html#ga716cdb9f63e56269824866872958dd78">XIicPs_SlaveInterruptHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="ga209dc1a98260b84e648df54ba923fc81"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_EVENT_RX_OVR&#160;&#160;&#160;0x0080U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8h.html">xiicps.h</a>&gt;</code></p>

<p>RX overflow. </p>

</div>
</div>
<a class="anchor" id="gac593e16a56addd3ff460a40ff04e1ed4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_EVENT_RX_UNF&#160;&#160;&#160;0x0200U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8h.html">xiicps.h</a>&gt;</code></p>

<p>RX underflow. </p>

</div>
</div>
<a class="anchor" id="ga71fcc8f7c4ee01454f8260667f30ed71"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_EVENT_SLAVE_RDY&#160;&#160;&#160;0x0040U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8h.html">xiicps.h</a>&gt;</code></p>

<p>Slave ready. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#gad64f0389aa694ecf21ca8a39e44cf13f">XIicPs_MasterInterruptHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="gab1ed271a1272c5c85d84f4b71b740dfb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_EVENT_TIME_OUT&#160;&#160;&#160;0x0004U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8h.html">xiicps.h</a>&gt;</code></p>

<p>Transfer timed out. </p>

</div>
</div>
<a class="anchor" id="ga809489609a6aabd5fd53c0242a565e59"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_EVENT_TX_OVR&#160;&#160;&#160;0x0100U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8h.html">xiicps.h</a>&gt;</code></p>

<p>TX overflow. </p>

</div>
</div>
<a class="anchor" id="ga609b88168d4a0681b42005e0d402a7eb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_FIFO_DEPTH&#160;&#160;&#160;16</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Number of bytes in the FIFO. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#gacfb0d8f18f8105db7708669ddb186e19">TransmitFifoFill()</a>, <a class="el" href="group__iicps__v3__0.html#gad64f0389aa694ecf21ca8a39e44cf13f">XIicPs_MasterInterruptHandler()</a>, <a class="el" href="group__iicps__v3__0.html#ga4817f45c28341cea4ab8960dc1203acb">XIicPs_MasterRecv()</a>, <a class="el" href="group__iicps__v3__0.html#ga21bdb2f8a1f09e027aa8b0e9d6648d75">XIicPs_MasterRecvPolled()</a>, <a class="el" href="group__iicps__v3__0.html#ga3027c1eb6ece3193a978a2da8e06c011">XIicPs_MasterSend()</a>, <a class="el" href="group__iicps__v3__0.html#ga71584f1a7e675cde41cfd9d1bd4320b4">XIicPs_MasterSendPolled()</a>, and <a class="el" href="group__iicps__v3__0.html#ga5ca49d9131b13d66f58de0b5a23faea4">XIicPs_SlaveSendPolled()</a>.</p>

</div>
</div>
<a class="anchor" id="gac95b4e2bd04257b322e5bf66f956bdf3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_IDR_OFFSET&#160;&#160;&#160;0x28U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Interrupt Disable. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#ga3eaa694ecd774beca05bf79c1f9df6c0">XIicPs_Abort()</a>, <a class="el" href="group__iicps__v3__0.html#ga1169a92eb8594d6f038816b5740916f7">XIicPs_Reset()</a>, and <a class="el" href="group__iicps__v3__0.html#gabfedbe03a6ac7de3d4e0ac192b8ab288">XIicPs_ResetHw()</a>.</p>

</div>
</div>
<a class="anchor" id="ga471cbaf2444941e33de173ea5e5c7f03"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_IER_OFFSET&#160;&#160;&#160;0x24U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Interrupt Enable. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#ga3eaa694ecd774beca05bf79c1f9df6c0">XIicPs_Abort()</a>.</p>

</div>
</div>
<a class="anchor" id="ga0668ec3389dd427fecfca4d1b9d2f0c4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_IMR_OFFSET&#160;&#160;&#160;0x20U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Interrupt Enabled Mask. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#ga3eaa694ecd774beca05bf79c1f9df6c0">XIicPs_Abort()</a>, <a class="el" href="group__iicps__v3__0.html#gad64f0389aa694ecf21ca8a39e44cf13f">XIicPs_MasterInterruptHandler()</a>, <a class="el" href="group__iicps__v3__0.html#ga6f9db7651cd6ee0232dc9fdaca3f976a">XIicPs_SelfTest()</a>, and <a class="el" href="group__iicps__v3__0.html#ga716cdb9f63e56269824866872958dd78">XIicPs_SlaveInterruptHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="ga9ec604e5ed330606d24a082484e905f0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_ISR_OFFSET&#160;&#160;&#160;0x10U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Interrupt Status. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#ga3eaa694ecd774beca05bf79c1f9df6c0">XIicPs_Abort()</a>, <a class="el" href="group__iicps__v3__0.html#gad64f0389aa694ecf21ca8a39e44cf13f">XIicPs_MasterInterruptHandler()</a>, <a class="el" href="group__iicps__v3__0.html#ga21bdb2f8a1f09e027aa8b0e9d6648d75">XIicPs_MasterRecvPolled()</a>, <a class="el" href="group__iicps__v3__0.html#ga71584f1a7e675cde41cfd9d1bd4320b4">XIicPs_MasterSendPolled()</a>, <a class="el" href="group__iicps__v3__0.html#gabfedbe03a6ac7de3d4e0ac192b8ab288">XIicPs_ResetHw()</a>, <a class="el" href="group__iicps__v3__0.html#ga716cdb9f63e56269824866872958dd78">XIicPs_SlaveInterruptHandler()</a>, <a class="el" href="group__iicps__v3__0.html#ga74b0af9e4395c8de724dc377e3504d0d">XIicPs_SlaveRecvPolled()</a>, and <a class="el" href="group__iicps__v3__0.html#ga5ca49d9131b13d66f58de0b5a23faea4">XIicPs_SlaveSendPolled()</a>.</p>

</div>
</div>
<a class="anchor" id="ga8e324637da3483d518d499b7257c7631"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_IXR_ALL_INTR_MASK&#160;&#160;&#160;0x000002FFU</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>All ISR Mask. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#ga3eaa694ecd774beca05bf79c1f9df6c0">XIicPs_Abort()</a>, <a class="el" href="group__iicps__v3__0.html#ga1169a92eb8594d6f038816b5740916f7">XIicPs_Reset()</a>, <a class="el" href="group__iicps__v3__0.html#gabfedbe03a6ac7de3d4e0ac192b8ab288">XIicPs_ResetHw()</a>, and <a class="el" href="group__iicps__v3__0.html#ga6f9db7651cd6ee0232dc9fdaca3f976a">XIicPs_SelfTest()</a>.</p>

</div>
</div>
<a class="anchor" id="ga88441aea66e1ef8f1fd211756b1d1630"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_IXR_ARB_LOST_MASK&#160;&#160;&#160;0x00000200U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Arbitration Lost Interrupt mask. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#gad64f0389aa694ecf21ca8a39e44cf13f">XIicPs_MasterInterruptHandler()</a>, <a class="el" href="group__iicps__v3__0.html#ga4817f45c28341cea4ab8960dc1203acb">XIicPs_MasterRecv()</a>, <a class="el" href="group__iicps__v3__0.html#ga21bdb2f8a1f09e027aa8b0e9d6648d75">XIicPs_MasterRecvPolled()</a>, <a class="el" href="group__iicps__v3__0.html#ga3027c1eb6ece3193a978a2da8e06c011">XIicPs_MasterSend()</a>, and <a class="el" href="group__iicps__v3__0.html#ga71584f1a7e675cde41cfd9d1bd4320b4">XIicPs_MasterSendPolled()</a>.</p>

</div>
</div>
<a class="anchor" id="ga56fefd834bba9cc03c0a84bd2a3e099a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_IXR_COMP_MASK&#160;&#160;&#160;0x00000001U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Transfer Complete Interrupt mask. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#gad64f0389aa694ecf21ca8a39e44cf13f">XIicPs_MasterInterruptHandler()</a>, <a class="el" href="group__iicps__v3__0.html#ga4817f45c28341cea4ab8960dc1203acb">XIicPs_MasterRecv()</a>, <a class="el" href="group__iicps__v3__0.html#ga3027c1eb6ece3193a978a2da8e06c011">XIicPs_MasterSend()</a>, <a class="el" href="group__iicps__v3__0.html#ga71584f1a7e675cde41cfd9d1bd4320b4">XIicPs_MasterSendPolled()</a>, <a class="el" href="group__iicps__v3__0.html#ga716cdb9f63e56269824866872958dd78">XIicPs_SlaveInterruptHandler()</a>, <a class="el" href="group__iicps__v3__0.html#ga1840936a940459c5a71858f94915f933">XIicPs_SlaveRecv()</a>, <a class="el" href="group__iicps__v3__0.html#ga74b0af9e4395c8de724dc377e3504d0d">XIicPs_SlaveRecvPolled()</a>, and <a class="el" href="group__iicps__v3__0.html#ga4478d1d94f349deda02c0191a7529113">XIicPs_SlaveSend()</a>.</p>

</div>
</div>
<a class="anchor" id="gaa4e9c302ebb54b53aa67ec6c9f4616a3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_IXR_DATA_MASK&#160;&#160;&#160;0x00000002U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Data Interrupt mask. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#gad64f0389aa694ecf21ca8a39e44cf13f">XIicPs_MasterInterruptHandler()</a>, <a class="el" href="group__iicps__v3__0.html#ga4817f45c28341cea4ab8960dc1203acb">XIicPs_MasterRecv()</a>, <a class="el" href="group__iicps__v3__0.html#ga716cdb9f63e56269824866872958dd78">XIicPs_SlaveInterruptHandler()</a>, <a class="el" href="group__iicps__v3__0.html#ga1840936a940459c5a71858f94915f933">XIicPs_SlaveRecv()</a>, <a class="el" href="group__iicps__v3__0.html#ga74b0af9e4395c8de724dc377e3504d0d">XIicPs_SlaveRecvPolled()</a>, and <a class="el" href="group__iicps__v3__0.html#ga4478d1d94f349deda02c0191a7529113">XIicPs_SlaveSend()</a>.</p>

</div>
</div>
<a class="anchor" id="ga98fd97807996f571433d9235dc0b0ca4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_IXR_DEFAULT_MASK&#160;&#160;&#160;0x000002FFU</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Default ISR Mask. </p>

</div>
</div>
<a class="anchor" id="ga74650276000c8cc48cce610b8c6d2140"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_IXR_NACK_MASK&#160;&#160;&#160;0x00000004U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>NACK Interrupt mask. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#gad64f0389aa694ecf21ca8a39e44cf13f">XIicPs_MasterInterruptHandler()</a>, <a class="el" href="group__iicps__v3__0.html#ga4817f45c28341cea4ab8960dc1203acb">XIicPs_MasterRecv()</a>, <a class="el" href="group__iicps__v3__0.html#ga21bdb2f8a1f09e027aa8b0e9d6648d75">XIicPs_MasterRecvPolled()</a>, <a class="el" href="group__iicps__v3__0.html#ga3027c1eb6ece3193a978a2da8e06c011">XIicPs_MasterSend()</a>, <a class="el" href="group__iicps__v3__0.html#ga71584f1a7e675cde41cfd9d1bd4320b4">XIicPs_MasterSendPolled()</a>, <a class="el" href="group__iicps__v3__0.html#ga716cdb9f63e56269824866872958dd78">XIicPs_SlaveInterruptHandler()</a>, <a class="el" href="group__iicps__v3__0.html#ga1840936a940459c5a71858f94915f933">XIicPs_SlaveRecv()</a>, <a class="el" href="group__iicps__v3__0.html#ga4478d1d94f349deda02c0191a7529113">XIicPs_SlaveSend()</a>, and <a class="el" href="group__iicps__v3__0.html#ga5ca49d9131b13d66f58de0b5a23faea4">XIicPs_SlaveSendPolled()</a>.</p>

</div>
</div>
<a class="anchor" id="ga1f69893ddec793ff77b61deb51665aa5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_IXR_RX_OVR_MASK&#160;&#160;&#160;0x00000020U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Receive Overflow Interrupt mask. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#gad64f0389aa694ecf21ca8a39e44cf13f">XIicPs_MasterInterruptHandler()</a>, <a class="el" href="group__iicps__v3__0.html#ga4817f45c28341cea4ab8960dc1203acb">XIicPs_MasterRecv()</a>, <a class="el" href="group__iicps__v3__0.html#ga21bdb2f8a1f09e027aa8b0e9d6648d75">XIicPs_MasterRecvPolled()</a>, <a class="el" href="group__iicps__v3__0.html#ga716cdb9f63e56269824866872958dd78">XIicPs_SlaveInterruptHandler()</a>, and <a class="el" href="group__iicps__v3__0.html#ga1840936a940459c5a71858f94915f933">XIicPs_SlaveRecv()</a>.</p>

</div>
</div>
<a class="anchor" id="ga6b92f85baedcc73892a141f80afe3462"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_IXR_RX_UNF_MASK&#160;&#160;&#160;0x00000080U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>FIFO Recieve Underflow Interrupt mask. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#gad64f0389aa694ecf21ca8a39e44cf13f">XIicPs_MasterInterruptHandler()</a>, <a class="el" href="group__iicps__v3__0.html#ga21bdb2f8a1f09e027aa8b0e9d6648d75">XIicPs_MasterRecvPolled()</a>, <a class="el" href="group__iicps__v3__0.html#ga716cdb9f63e56269824866872958dd78">XIicPs_SlaveInterruptHandler()</a>, and <a class="el" href="group__iicps__v3__0.html#ga1840936a940459c5a71858f94915f933">XIicPs_SlaveRecv()</a>.</p>

</div>
</div>
<a class="anchor" id="ga5c873e7df9f7a05e458b0d7e9b50faa9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_IXR_SLV_RDY_MASK&#160;&#160;&#160;0x00000010U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Monitored Slave Ready Interrupt mask. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#ga15f2e8071ff8d8e1ec1dc56d29ab202b">XIicPs_DisableSlaveMonitor()</a>, <a class="el" href="group__iicps__v3__0.html#ga597faa64ccaf3d8034e3e92989048f06">XIicPs_EnableSlaveMonitor()</a>, and <a class="el" href="group__iicps__v3__0.html#gad64f0389aa694ecf21ca8a39e44cf13f">XIicPs_MasterInterruptHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="ga6df84833528a63b5f5fb07a7d1743c91"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_IXR_TO_MASK&#160;&#160;&#160;0x00000008U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Transfer Time Out Interrupt mask. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#ga716cdb9f63e56269824866872958dd78">XIicPs_SlaveInterruptHandler()</a>, <a class="el" href="group__iicps__v3__0.html#ga1840936a940459c5a71858f94915f933">XIicPs_SlaveRecv()</a>, and <a class="el" href="group__iicps__v3__0.html#ga4478d1d94f349deda02c0191a7529113">XIicPs_SlaveSend()</a>.</p>

</div>
</div>
<a class="anchor" id="gad2473caf4558fac9af1bd071a022e3cf"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_IXR_TX_OVR_MASK&#160;&#160;&#160;0x00000040U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Transmit Overflow Interrupt mask. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#gad64f0389aa694ecf21ca8a39e44cf13f">XIicPs_MasterInterruptHandler()</a>, <a class="el" href="group__iicps__v3__0.html#ga71584f1a7e675cde41cfd9d1bd4320b4">XIicPs_MasterSendPolled()</a>, <a class="el" href="group__iicps__v3__0.html#ga716cdb9f63e56269824866872958dd78">XIicPs_SlaveInterruptHandler()</a>, and <a class="el" href="group__iicps__v3__0.html#ga4478d1d94f349deda02c0191a7529113">XIicPs_SlaveSend()</a>.</p>

</div>
</div>
<a class="anchor" id="gab8f0f78d7389924d17d2b7b49f622cf1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIicPs_ReadIER</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">BaseAddress</td><td>)</td>
          <td>&#160;&#160;&#160;<a class="el" href="group__iicps__v3__0.html#gabcc20fce80c1e8dff27be4e584c2cc27">XIicPs_ReadReg</a>((BaseAddress),  <a class="el" href="group__iicps__v3__0.html#ga471cbaf2444941e33de173ea5e5c7f03">XIICPS_IER_OFFSET</a>)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Read the interrupt enable register. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BaseAddress</td><td>contains the base address of the device.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Current bit mask that represents currently enabled interrupts.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-Style signature: u32 <a class="el" href="group__iicps__v3__0.html#gab8f0f78d7389924d17d2b7b49f622cf1" title="Read the interrupt enable register. ">XIicPs_ReadIER(u32 BaseAddress)</a> </dd></dl>

</div>
</div>
<a class="anchor" id="gabcc20fce80c1e8dff27be4e584c2cc27"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIicPs_ReadReg</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">BaseAddress, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">RegOffset&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;XIicPs_In32((BaseAddress) + (u32)(RegOffset))</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Read an IIC register. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BaseAddress</td><td>contains the base address of the device. </td></tr>
    <tr><td class="paramname">RegOffset</td><td>contains the offset from the 1st register of the device to select the specific register.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The value read from the register.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-Style signature: u32 XIicPs_ReadReg(u32 BaseAddress. int RegOffset) </dd></dl>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#gacfb0d8f18f8105db7708669ddb186e19">TransmitFifoFill()</a>, <a class="el" href="group__iicps__v3__0.html#ga3eaa694ecd774beca05bf79c1f9df6c0">XIicPs_Abort()</a>, <a class="el" href="group__iicps__v3__0.html#ga5b67ad96b8c40bdd47c2c2f8a57f170c">XIicPs_BusIsBusy()</a>, <a class="el" href="group__iicps__v3__0.html#ga87cbf2622a9c6ad66b18d4c3f9575a76">XIicPs_ClearOptions()</a>, <a class="el" href="group__iicps__v3__0.html#ga15f2e8071ff8d8e1ec1dc56d29ab202b">XIicPs_DisableSlaveMonitor()</a>, <a class="el" href="group__iicps__v3__0.html#ga597faa64ccaf3d8034e3e92989048f06">XIicPs_EnableSlaveMonitor()</a>, <a class="el" href="group__iicps__v3__0.html#ga20964e35a74f4e16f90e78510c9b4337">XIicPs_GetOptions()</a>, <a class="el" href="group__iicps__v3__0.html#ga9f2d2d3d11c2c9125a5bc8a0d95593cb">XIicPs_GetSClk()</a>, <a class="el" href="group__iicps__v3__0.html#gad64f0389aa694ecf21ca8a39e44cf13f">XIicPs_MasterInterruptHandler()</a>, <a class="el" href="group__iicps__v3__0.html#ga4817f45c28341cea4ab8960dc1203acb">XIicPs_MasterRecv()</a>, <a class="el" href="group__iicps__v3__0.html#ga21bdb2f8a1f09e027aa8b0e9d6648d75">XIicPs_MasterRecvPolled()</a>, <a class="el" href="group__iicps__v3__0.html#ga3027c1eb6ece3193a978a2da8e06c011">XIicPs_MasterSend()</a>, <a class="el" href="group__iicps__v3__0.html#ga71584f1a7e675cde41cfd9d1bd4320b4">XIicPs_MasterSendPolled()</a>, <a class="el" href="group__iicps__v3__0.html#gabfedbe03a6ac7de3d4e0ac192b8ab288">XIicPs_ResetHw()</a>, <a class="el" href="group__iicps__v3__0.html#ga6f9db7651cd6ee0232dc9fdaca3f976a">XIicPs_SelfTest()</a>, <a class="el" href="group__iicps__v3__0.html#gaec1dc5be2be8a7394263cfe56af976c5">XIicPs_SetOptions()</a>, <a class="el" href="group__iicps__v3__0.html#gafb24cfdacf6cf28d80126862dc1cfbe5">XIicPs_SetSClk()</a>, <a class="el" href="group__iicps__v3__0.html#ga716cdb9f63e56269824866872958dd78">XIicPs_SlaveInterruptHandler()</a>, <a class="el" href="group__iicps__v3__0.html#ga74b0af9e4395c8de724dc377e3504d0d">XIicPs_SlaveRecvPolled()</a>, and <a class="el" href="group__iicps__v3__0.html#ga5ca49d9131b13d66f58de0b5a23faea4">XIicPs_SlaveSendPolled()</a>.</p>

</div>
</div>
<a class="anchor" id="ga820f2cd7e2c7b77b9b5966e87eae2c09"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_REP_START_OPTION&#160;&#160;&#160;0x08U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8h.html">xiicps.h</a>&gt;</code></p>

<p>Repeated Start. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#ga87cbf2622a9c6ad66b18d4c3f9575a76">XIicPs_ClearOptions()</a>, <a class="el" href="group__iicps__v3__0.html#ga20964e35a74f4e16f90e78510c9b4337">XIicPs_GetOptions()</a>, and <a class="el" href="group__iicps__v3__0.html#gaec1dc5be2be8a7394263cfe56af976c5">XIicPs_SetOptions()</a>.</p>

</div>
</div>
<a class="anchor" id="ga7748c81bca2cc231cba3fa780530d95a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_SLAVE_MON_OPTION&#160;&#160;&#160;0x04U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8h.html">xiicps.h</a>&gt;</code></p>

<p>Slave monitor mode. </p>

</div>
</div>
<a class="anchor" id="ga6bc4423ced1691dc807ed57ddf4d2a97"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_SLV_PAUSE_MASK&#160;&#160;&#160;0x0000000F</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Slave monitor pause mask. </p>

</div>
</div>
<a class="anchor" id="ga3750481db8ebadadea48985f0abcb755"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_SLV_PAUSE_OFFSET&#160;&#160;&#160;0x18U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Slave monitor pause. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#ga597faa64ccaf3d8034e3e92989048f06">XIicPs_EnableSlaveMonitor()</a>, and <a class="el" href="group__iicps__v3__0.html#ga6f9db7651cd6ee0232dc9fdaca3f976a">XIicPs_SelfTest()</a>.</p>

</div>
</div>
<a class="anchor" id="ga67aa73d65f217cb22ecbbb10711ea561"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_SR_BA_MASK&#160;&#160;&#160;0x00000100U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Bus Active Mask. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#ga5b67ad96b8c40bdd47c2c2f8a57f170c">XIicPs_BusIsBusy()</a>.</p>

</div>
</div>
<a class="anchor" id="ga12b4d0ee4dce6172ba78a0dec5666a72"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_SR_OFFSET&#160;&#160;&#160;0x04U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Status. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#ga5b67ad96b8c40bdd47c2c2f8a57f170c">XIicPs_BusIsBusy()</a>, <a class="el" href="group__iicps__v3__0.html#gad64f0389aa694ecf21ca8a39e44cf13f">XIicPs_MasterInterruptHandler()</a>, <a class="el" href="group__iicps__v3__0.html#ga21bdb2f8a1f09e027aa8b0e9d6648d75">XIicPs_MasterRecvPolled()</a>, <a class="el" href="group__iicps__v3__0.html#ga71584f1a7e675cde41cfd9d1bd4320b4">XIicPs_MasterSendPolled()</a>, <a class="el" href="group__iicps__v3__0.html#gabfedbe03a6ac7de3d4e0ac192b8ab288">XIicPs_ResetHw()</a>, <a class="el" href="group__iicps__v3__0.html#ga74b0af9e4395c8de724dc377e3504d0d">XIicPs_SlaveRecvPolled()</a>, and <a class="el" href="group__iicps__v3__0.html#ga5ca49d9131b13d66f58de0b5a23faea4">XIicPs_SlaveSendPolled()</a>.</p>

</div>
</div>
<a class="anchor" id="gafbe8fcac03eab822b049d469485356d0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_SR_RXDV_MASK&#160;&#160;&#160;0x00000020U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Receiver Data Valid Mask. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#gad64f0389aa694ecf21ca8a39e44cf13f">XIicPs_MasterInterruptHandler()</a>, <a class="el" href="group__iicps__v3__0.html#ga21bdb2f8a1f09e027aa8b0e9d6648d75">XIicPs_MasterRecvPolled()</a>, <a class="el" href="group__iicps__v3__0.html#ga74b0af9e4395c8de724dc377e3504d0d">XIicPs_SlaveRecvPolled()</a>, and <a class="el" href="group__iicps__v3__0.html#ga5ca49d9131b13d66f58de0b5a23faea4">XIicPs_SlaveSendPolled()</a>.</p>

</div>
</div>
<a class="anchor" id="gae886bd15d96c8e3e3e8bbbcbc4878a5c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_SR_RXOVF_MASK&#160;&#160;&#160;0x00000080U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Receiver Overflow Mask. </p>

</div>
</div>
<a class="anchor" id="ga694b3781a9539f3c34b97a4d58b68efd"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_SR_RXRW_MASK&#160;&#160;&#160;0x00000008U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Receive read/write Mask. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#ga5ca49d9131b13d66f58de0b5a23faea4">XIicPs_SlaveSendPolled()</a>.</p>

</div>
</div>
<a class="anchor" id="ga4ec47ab77103b89564d25650fee6132f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_SR_TXDV_MASK&#160;&#160;&#160;0x00000040U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Transmit Data Valid Mask. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#ga71584f1a7e675cde41cfd9d1bd4320b4">XIicPs_MasterSendPolled()</a>, and <a class="el" href="group__iicps__v3__0.html#ga5ca49d9131b13d66f58de0b5a23faea4">XIicPs_SlaveSendPolled()</a>.</p>

</div>
</div>
<a class="anchor" id="ga5816d28492ddffba63659c197da00ed2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_TIME_OUT_MASK&#160;&#160;&#160;0x000000FFU</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>IIC Time Out mask. </p>

</div>
</div>
<a class="anchor" id="ga61f5015241d07352f5cad00c589ec4e0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_TIME_OUT_OFFSET&#160;&#160;&#160;0x1CU</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Time Out. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#ga1169a92eb8594d6f038816b5740916f7">XIicPs_Reset()</a>, and <a class="el" href="group__iicps__v3__0.html#gabfedbe03a6ac7de3d4e0ac192b8ab288">XIicPs_ResetHw()</a>.</p>

</div>
</div>
<a class="anchor" id="gafbad4feee5924c925b1fe0d864c3799a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_TO_RESET_VALUE&#160;&#160;&#160;0x000000FFU</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>IIC Time Out reset value. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#ga1169a92eb8594d6f038816b5740916f7">XIicPs_Reset()</a>, and <a class="el" href="group__iicps__v3__0.html#gabfedbe03a6ac7de3d4e0ac192b8ab288">XIicPs_ResetHw()</a>.</p>

</div>
</div>
<a class="anchor" id="ga15b4866837028af069caa628b3a855c2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_TRANS_SIZE_MASK&#160;&#160;&#160;0x0000003F</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>IIC Transfer Size Mask. </p>

</div>
</div>
<a class="anchor" id="ga2afdc061285f0155f3fbbf322beae54f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIICPS_TRANS_SIZE_OFFSET&#160;&#160;&#160;0x14U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Transfer Size. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#gacfb0d8f18f8105db7708669ddb186e19">TransmitFifoFill()</a>, <a class="el" href="group__iicps__v3__0.html#ga597faa64ccaf3d8034e3e92989048f06">XIicPs_EnableSlaveMonitor()</a>, <a class="el" href="group__iicps__v3__0.html#gad64f0389aa694ecf21ca8a39e44cf13f">XIicPs_MasterInterruptHandler()</a>, <a class="el" href="group__iicps__v3__0.html#ga4817f45c28341cea4ab8960dc1203acb">XIicPs_MasterRecv()</a>, <a class="el" href="group__iicps__v3__0.html#ga21bdb2f8a1f09e027aa8b0e9d6648d75">XIicPs_MasterRecvPolled()</a>, <a class="el" href="group__iicps__v3__0.html#gabfedbe03a6ac7de3d4e0ac192b8ab288">XIicPs_ResetHw()</a>, and <a class="el" href="group__iicps__v3__0.html#gafb24cfdacf6cf28d80126862dc1cfbe5">XIicPs_SetSClk()</a>.</p>

</div>
</div>
<a class="anchor" id="gaa0bde6894589023ea8248a9d9cdc73c5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIicPs_WriteReg</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">BaseAddress, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">RegOffset, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">RegisterValue&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;XIicPs_Out32((BaseAddress) + (u32)(RegOffset), (u32)(RegisterValue))</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8h.html">xiicps_hw.h</a>&gt;</code></p>

<p>Write an IIC register. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BaseAddress</td><td>contains the base address of the device. </td></tr>
    <tr><td class="paramname">RegOffset</td><td>contains the offset from the 1st register of the device to select the specific register. </td></tr>
    <tr><td class="paramname">RegisterValue</td><td>is the value to be written to the register.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-Style signature: void <a class="el" href="group__iicps__v3__0.html#gaa0bde6894589023ea8248a9d9cdc73c5" title="Write an IIC register. ">XIicPs_WriteReg(u32 BaseAddress, int RegOffset, u32 RegisterValue)</a> </dd></dl>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#ga3eaa694ecd774beca05bf79c1f9df6c0">XIicPs_Abort()</a>, <a class="el" href="group__iicps__v3__0.html#ga87cbf2622a9c6ad66b18d4c3f9575a76">XIicPs_ClearOptions()</a>, <a class="el" href="group__iicps__v3__0.html#ga15f2e8071ff8d8e1ec1dc56d29ab202b">XIicPs_DisableSlaveMonitor()</a>, <a class="el" href="group__iicps__v3__0.html#ga597faa64ccaf3d8034e3e92989048f06">XIicPs_EnableSlaveMonitor()</a>, <a class="el" href="group__iicps__v3__0.html#gad64f0389aa694ecf21ca8a39e44cf13f">XIicPs_MasterInterruptHandler()</a>, <a class="el" href="group__iicps__v3__0.html#ga4817f45c28341cea4ab8960dc1203acb">XIicPs_MasterRecv()</a>, <a class="el" href="group__iicps__v3__0.html#ga21bdb2f8a1f09e027aa8b0e9d6648d75">XIicPs_MasterRecvPolled()</a>, <a class="el" href="group__iicps__v3__0.html#ga3027c1eb6ece3193a978a2da8e06c011">XIicPs_MasterSend()</a>, <a class="el" href="group__iicps__v3__0.html#ga71584f1a7e675cde41cfd9d1bd4320b4">XIicPs_MasterSendPolled()</a>, <a class="el" href="group__iicps__v3__0.html#ga1169a92eb8594d6f038816b5740916f7">XIicPs_Reset()</a>, <a class="el" href="group__iicps__v3__0.html#gabfedbe03a6ac7de3d4e0ac192b8ab288">XIicPs_ResetHw()</a>, <a class="el" href="group__iicps__v3__0.html#ga6f9db7651cd6ee0232dc9fdaca3f976a">XIicPs_SelfTest()</a>, <a class="el" href="group__iicps__v3__0.html#gaec1dc5be2be8a7394263cfe56af976c5">XIicPs_SetOptions()</a>, <a class="el" href="group__iicps__v3__0.html#gafb24cfdacf6cf28d80126862dc1cfbe5">XIicPs_SetSClk()</a>, <a class="el" href="group__iicps__v3__0.html#gad1c7ffa09df93fb59f97b0a3bf5baaa7">XIicPs_SetupSlave()</a>, <a class="el" href="group__iicps__v3__0.html#ga716cdb9f63e56269824866872958dd78">XIicPs_SlaveInterruptHandler()</a>, <a class="el" href="group__iicps__v3__0.html#ga74b0af9e4395c8de724dc377e3504d0d">XIicPs_SlaveRecvPolled()</a>, and <a class="el" href="group__iicps__v3__0.html#ga5ca49d9131b13d66f58de0b5a23faea4">XIicPs_SlaveSendPolled()</a>.</p>

</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="gaabcfd3b5d9ed949a553a992242237cba"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef void(* XIicPs_IntrHandler) (void *CallBackRef, u32 StatusEvent)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8h.html">xiicps.h</a>&gt;</code></p>

<p>The handler data type allows the user to define a callback function to respond to interrupt events in the system. </p>
<p>This function is executed in interrupt context, so amount of processing should be minimized.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">CallBackRef</td><td>is the callback reference passed in by the upper layer when setting the callback functions, and passed back to the upper layer when the callback is invoked. Its type is not important to the driver, so it is a void pointer. </td></tr>
    <tr><td class="paramname">StatusEvent</td><td>indicates one or more status events that occurred. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gacfb0d8f18f8105db7708669ddb186e19"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">s32 TransmitFifoFill </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_iic_ps.html">XIicPs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8c.html">xiicps.c</a>&gt;</code></p>

<p>Put more data into the transmit FIFO, number of bytes is ether expected number of bytes for this transfer or available space in FIFO, which ever is less. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_iic_ps.html" title="The XIicPs driver instance data. ">XIicPs</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of bytes left for this instance.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This is function is shared by master and slave. </dd></dl>

<p>References <a class="el" href="group__iicps__v3__0.html#ga6809c43387826c1f50e719163d4d9d27">XIicPs_Config::BaseAddress</a>, <a class="el" href="group__iicps__v3__0.html#ga609b88168d4a0681b42005e0d402a7eb">XIICPS_FIFO_DEPTH</a>, <a class="el" href="group__iicps__v3__0.html#gabcc20fce80c1e8dff27be4e584c2cc27">XIicPs_ReadReg</a>, and <a class="el" href="group__iicps__v3__0.html#ga2afdc061285f0155f3fbbf322beae54f">XIICPS_TRANS_SIZE_OFFSET</a>.</p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#ga3027c1eb6ece3193a978a2da8e06c011">XIicPs_MasterSend()</a>, <a class="el" href="group__iicps__v3__0.html#ga71584f1a7e675cde41cfd9d1bd4320b4">XIicPs_MasterSendPolled()</a>, and <a class="el" href="group__iicps__v3__0.html#ga716cdb9f63e56269824866872958dd78">XIicPs_SlaveInterruptHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="ga3eaa694ecd774beca05bf79c1f9df6c0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XIicPs_Abort </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_iic_ps.html">XIicPs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8c.html">xiicps.c</a>&gt;</code></p>

<p>Aborts a transfer in progress by resetting the FIFOs. </p>
<p>The byte counts are cleared.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_iic_ps.html" title="The XIicPs driver instance data. ">XIicPs</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="group__iicps__v3__0.html#ga6809c43387826c1f50e719163d4d9d27">XIicPs_Config::BaseAddress</a>, <a class="el" href="group__iicps__v3__0.html#ga167d2a48ba5ab4cdf58f229bf6a0b554">XIICPS_CR_CLR_FIFO_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga0c96ab97015c857822df599608ba9c10">XIICPS_CR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#ga42b856fa59af3400a93291cf0e652307">XIICPS_CR_RESET_VALUE</a>, <a class="el" href="group__iicps__v3__0.html#gac95b4e2bd04257b322e5bf66f956bdf3">XIICPS_IDR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#ga471cbaf2444941e33de173ea5e5c7f03">XIICPS_IER_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#ga0668ec3389dd427fecfca4d1b9d2f0c4">XIICPS_IMR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#ga9ec604e5ed330606d24a082484e905f0">XIICPS_ISR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#ga8e324637da3483d518d499b7257c7631">XIICPS_IXR_ALL_INTR_MASK</a>, <a class="el" href="group__iicps__v3__0.html#gabcc20fce80c1e8dff27be4e584c2cc27">XIicPs_ReadReg</a>, and <a class="el" href="group__iicps__v3__0.html#gaa0bde6894589023ea8248a9d9cdc73c5">XIicPs_WriteReg</a>.</p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#ga1169a92eb8594d6f038816b5740916f7">XIicPs_Reset()</a>.</p>

</div>
</div>
<a class="anchor" id="ga5b67ad96b8c40bdd47c2c2f8a57f170c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">s32 XIicPs_BusIsBusy </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_iic_ps.html">XIicPs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8c.html">xiicps.c</a>&gt;</code></p>

<p>Check whether the I2C bus is busy. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_iic_ps.html" title="The XIicPs driver instance data. ">XIicPs</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>TRUE if the bus is busy.</li>
</ul>
</dd></dl>
<ul>
<li>FALSE if the bus is not busy.</li>
</ul>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="group__iicps__v3__0.html#ga6809c43387826c1f50e719163d4d9d27">XIicPs_Config::BaseAddress</a>, <a class="el" href="group__iicps__v3__0.html#gabcc20fce80c1e8dff27be4e584c2cc27">XIicPs_ReadReg</a>, <a class="el" href="group__iicps__v3__0.html#ga67aa73d65f217cb22ecbbb10711ea561">XIICPS_SR_BA_MASK</a>, and <a class="el" href="group__iicps__v3__0.html#ga12b4d0ee4dce6172ba78a0dec5666a72">XIICPS_SR_OFFSET</a>.</p>

</div>
</div>
<a class="anchor" id="gae97ad9c202953c7e49bfb56533c47079"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">s32 XIicPs_CfgInitialize </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_iic_ps.html">XIicPs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_iic_ps___config.html">XIicPs_Config</a> *&#160;</td>
          <td class="paramname"><em>ConfigPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>EffectiveAddr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8c.html">xiicps.c</a>&gt;</code></p>

<p>Initializes a specific <a class="el" href="struct_x_iic_ps.html" title="The XIicPs driver instance data. ">XIicPs</a> instance such that the driver is ready to use. </p>
<p>The state of the device after initialization is:</p><ul>
<li>Device is disabled</li>
<li>Slave mode</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_iic_ps.html" title="The XIicPs driver instance data. ">XIicPs</a> instance. </td></tr>
    <tr><td class="paramname">ConfigPtr</td><td>is a reference to a structure containing information about a specific IIC device. This function initializes an InstancePtr object for a specific device specified by the contents of Config. </td></tr>
    <tr><td class="paramname">EffectiveAddr</td><td>is the device base address in the virtual memory address space. The caller is responsible for keeping the address mapping from EffectiveAddr to the device physical base address unchanged once this function is invoked. Unexpected errors may occur if the address mapping changes after this function is called. If address translation is not used, use ConfigPtr-&gt;BaseAddress for this parameter, passing the physical address instead.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The return value is XST_SUCCESS if successful.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="group__iicps__v3__0.html#ga6809c43387826c1f50e719163d4d9d27">XIicPs_Config::BaseAddress</a>, <a class="el" href="group__iicps__v3__0.html#gab1b5b0096bd5138a78be794448e6b681">XIicPs_Config::DeviceId</a>, <a class="el" href="group__iicps__v3__0.html#gafbb42f3963d40b41b322b76c88dcd916">XIicPs_Config::InputClockHz</a>, <a class="el" href="group__iicps__v3__0.html#ga20964e35a74f4e16f90e78510c9b4337">XIicPs_GetOptions()</a>, and <a class="el" href="group__iicps__v3__0.html#ga1169a92eb8594d6f038816b5740916f7">XIicPs_Reset()</a>.</p>

</div>
</div>
<a class="anchor" id="ga87cbf2622a9c6ad66b18d4c3f9575a76"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">s32 XIicPs_ClearOptions </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_iic_ps.html">XIicPs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>Options</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8h.html">xiicps.h</a>&gt;</code></p>

<p>This function clears the options for the IIC device driver. </p>
<p>The options control how the device behaves relative to the IIC bus. The device must be idle rather than busy transferring data before setting these device options.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_iic_ps.html" title="The XIicPs driver instance data. ">XIicPs</a> instance. </td></tr>
    <tr><td class="paramname">Options</td><td>contains the specified options to be cleared. This is a bit mask where a 1 means to turn the option off. One or more bit values may be contained in the mask. See the bit definitions named XIICPS_*_OPTION in <a class="el" href="xiicps_8h.html">xiicps.h</a>.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if options are successfully set.</li>
<li>XST_DEVICE_IS_STARTED if the device is currently transferring data. The transfer must complete or be aborted before setting options.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None </dd></dl>

<p>References <a class="el" href="group__iicps__v3__0.html#ga6809c43387826c1f50e719163d4d9d27">XIicPs_Config::BaseAddress</a>, <a class="el" href="group__iicps__v3__0.html#ga4057e55c42ab0d06b32c55d5e67e0029">XIICPS_10_BIT_ADDR_OPTION</a>, <a class="el" href="group__iicps__v3__0.html#ga0c96ab97015c857822df599608ba9c10">XIICPS_CR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#ga20964e35a74f4e16f90e78510c9b4337">XIicPs_GetOptions()</a>, <a class="el" href="group__iicps__v3__0.html#gabcc20fce80c1e8dff27be4e584c2cc27">XIicPs_ReadReg</a>, <a class="el" href="group__iicps__v3__0.html#ga820f2cd7e2c7b77b9b5966e87eae2c09">XIICPS_REP_START_OPTION</a>, and <a class="el" href="group__iicps__v3__0.html#gaa0bde6894589023ea8248a9d9cdc73c5">XIicPs_WriteReg</a>.</p>

</div>
</div>
<a class="anchor" id="ga15f2e8071ff8d8e1ec1dc56d29ab202b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XIicPs_DisableSlaveMonitor </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_iic_ps.html">XIicPs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8h.html">xiicps.h</a>&gt;</code></p>

<p>This function disables slave monitor mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_iic_ps.html" title="The XIicPs driver instance data. ">XIicPs</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="group__iicps__v3__0.html#ga6809c43387826c1f50e719163d4d9d27">XIicPs_Config::BaseAddress</a>, <a class="el" href="group__iicps__v3__0.html#ga0c96ab97015c857822df599608ba9c10">XIICPS_CR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#gade5ece1da092340afd300afe0387f207">XIICPS_CR_SLVMON_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga6a21536b3361fa36f00745a3e653fbbd">XIicPs_DisableInterrupts</a>, <a class="el" href="group__iicps__v3__0.html#ga5c873e7df9f7a05e458b0d7e9b50faa9">XIICPS_IXR_SLV_RDY_MASK</a>, <a class="el" href="group__iicps__v3__0.html#gabcc20fce80c1e8dff27be4e584c2cc27">XIicPs_ReadReg</a>, and <a class="el" href="group__iicps__v3__0.html#gaa0bde6894589023ea8248a9d9cdc73c5">XIicPs_WriteReg</a>.</p>

</div>
</div>
<a class="anchor" id="ga597faa64ccaf3d8034e3e92989048f06"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XIicPs_EnableSlaveMonitor </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_iic_ps.html">XIicPs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>SlaveAddr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8h.html">xiicps.h</a>&gt;</code></p>

<p>This function enables the slave monitor mode. </p>
<p>It enables slave monitor in the control register and enables slave ready interrupt. It then does an address transfer to slave. Interrupt handler will signal the caller if slave responds to the address transfer.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_iic_ps.html" title="The XIicPs driver instance data. ">XIicPs</a> instance. </td></tr>
    <tr><td class="paramname">SlaveAddr</td><td>is the address of the slave we want to contact.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="group__iicps__v3__0.html#ga6809c43387826c1f50e719163d4d9d27">XIicPs_Config::BaseAddress</a>, <a class="el" href="group__iicps__v3__0.html#ga3d97551edd7013b07093cac16dbe80f1">XIICPS_ADDR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#ga167d2a48ba5ab4cdf58f229bf6a0b554">XIICPS_CR_CLR_FIFO_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga77c04588069ca5f72be4e8177ff6c0d8">XIICPS_CR_MS_MASK</a>, <a class="el" href="group__iicps__v3__0.html#gada95425b2ab9cb404dcdc418d667370c">XIICPS_CR_NEA_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga0c96ab97015c857822df599608ba9c10">XIICPS_CR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#gad8c3988f9bb22c7d3f2ce88f6a7f0aa0">XIICPS_CR_RD_WR_MASK</a>, <a class="el" href="group__iicps__v3__0.html#gade5ece1da092340afd300afe0387f207">XIICPS_CR_SLVMON_MASK</a>, <a class="el" href="group__iicps__v3__0.html#gaf7a3f4b57fe275f426ac9b771b187b23">XIicPs_EnableInterrupts</a>, <a class="el" href="group__iicps__v3__0.html#ga5c873e7df9f7a05e458b0d7e9b50faa9">XIICPS_IXR_SLV_RDY_MASK</a>, <a class="el" href="group__iicps__v3__0.html#gabcc20fce80c1e8dff27be4e584c2cc27">XIicPs_ReadReg</a>, <a class="el" href="group__iicps__v3__0.html#ga3750481db8ebadadea48985f0abcb755">XIICPS_SLV_PAUSE_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#ga2afdc061285f0155f3fbbf322beae54f">XIICPS_TRANS_SIZE_OFFSET</a>, and <a class="el" href="group__iicps__v3__0.html#gaa0bde6894589023ea8248a9d9cdc73c5">XIicPs_WriteReg</a>.</p>

</div>
</div>
<a class="anchor" id="ga20964e35a74f4e16f90e78510c9b4337"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XIicPs_GetOptions </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_iic_ps.html">XIicPs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8h.html">xiicps.h</a>&gt;</code></p>

<p>This function gets the options for the IIC device. </p>
<p>The options control how the device behaves relative to the IIC bus.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_iic_ps.html" title="The XIicPs driver instance data. ">XIicPs</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>32 bit mask of the options, where a 1 means the option is on, and a 0 means to the option is off. One or more bit values may be contained in the mask. See the bit definitions named XIICPS_*_OPTION in the file <a class="el" href="xiicps_8h.html">xiicps.h</a>.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="group__iicps__v3__0.html#ga6809c43387826c1f50e719163d4d9d27">XIicPs_Config::BaseAddress</a>, <a class="el" href="group__iicps__v3__0.html#ga4057e55c42ab0d06b32c55d5e67e0029">XIICPS_10_BIT_ADDR_OPTION</a>, <a class="el" href="group__iicps__v3__0.html#gada95425b2ab9cb404dcdc418d667370c">XIICPS_CR_NEA_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga0c96ab97015c857822df599608ba9c10">XIICPS_CR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#gabcc20fce80c1e8dff27be4e584c2cc27">XIicPs_ReadReg</a>, and <a class="el" href="group__iicps__v3__0.html#ga820f2cd7e2c7b77b9b5966e87eae2c09">XIICPS_REP_START_OPTION</a>.</p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#gae97ad9c202953c7e49bfb56533c47079">XIicPs_CfgInitialize()</a>, <a class="el" href="group__iicps__v3__0.html#ga87cbf2622a9c6ad66b18d4c3f9575a76">XIicPs_ClearOptions()</a>, and <a class="el" href="group__iicps__v3__0.html#gaec1dc5be2be8a7394263cfe56af976c5">XIicPs_SetOptions()</a>.</p>

</div>
</div>
<a class="anchor" id="ga9f2d2d3d11c2c9125a5bc8a0d95593cb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XIicPs_GetSClk </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_iic_ps.html">XIicPs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8h.html">xiicps.h</a>&gt;</code></p>

<p>This function gets the serial clock rate for the IIC device. </p>
<p>The device must be idle rather than busy transferring data before setting these device options.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_iic_ps.html" title="The XIicPs driver instance data. ">XIicPs</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The value of the IIC clock to the nearest Hz based on the control register settings. The actual value may not be exact to to integer math rounding errors.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="group__iicps__v3__0.html#ga6809c43387826c1f50e719163d4d9d27">XIicPs_Config::BaseAddress</a>, <a class="el" href="group__iicps__v3__0.html#gafbb42f3963d40b41b322b76c88dcd916">XIicPs_Config::InputClockHz</a>, <a class="el" href="group__iicps__v3__0.html#gae1eb58bcf8d77fd6a8f9325d5344b390">XIICPS_CR_DIV_A_MASK</a>, <a class="el" href="group__iicps__v3__0.html#gae980b732a8b41e97461d097cdca82d38">XIICPS_CR_DIV_A_SHIFT</a>, <a class="el" href="group__iicps__v3__0.html#gaee06a0e2ceece45ef3ca15fffacbaac3">XIICPS_CR_DIV_B_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga0475ff513956035cd712dd4ee3301364">XIICPS_CR_DIV_B_SHIFT</a>, <a class="el" href="group__iicps__v3__0.html#ga0c96ab97015c857822df599608ba9c10">XIICPS_CR_OFFSET</a>, and <a class="el" href="group__iicps__v3__0.html#gabcc20fce80c1e8dff27be4e584c2cc27">XIicPs_ReadReg</a>.</p>

</div>
</div>
<a class="anchor" id="ga14c7ff4f51185d8aab0028c0eeb3c336"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_iic_ps___config.html">XIicPs_Config</a> * XIicPs_LookupConfig </td>
          <td>(</td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>DeviceId</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8h.html">xiicps.h</a>&gt;</code></p>

<p>Looks up the device configuration based on the unique device ID. </p>
<p>A table contains the configuration info for each device in the system.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">DeviceId</td><td>contains the ID of the device to look up the configuration for.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the configuration found or NULL if the specified device ID was not found. See <a class="el" href="xiicps_8h.html">xiicps.h</a> for the definition of <a class="el" href="struct_x_iic_ps___config.html" title="This typedef contains configuration information for the device. ">XIicPs_Config</a>.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

</div>
</div>
<a class="anchor" id="gad64f0389aa694ecf21ca8a39e44cf13f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XIicPs_MasterInterruptHandler </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_iic_ps.html">XIicPs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8h.html">xiicps.h</a>&gt;</code></p>

<p>The interrupt handler for the master mode. </p>
<p>It does the protocol handling for the interrupt-driven transfers.</p>
<p>Completion events and errors are signaled to upper layer for proper handling.</p>
<pre>
The interrupts that are handled are:</p><ul>
<li>DATA
      This case is handled only for master receive data.
      The master has to request for more data (if there is more data to
      receive) and read the data from the FIFO .</li>
</ul>
</pre><pre><ul>
<li><p class="startli">COMP
      If the Master is transmitting data and there is more data to be
      sent then the data is written to the FIFO. If there is no more data to
      be transmitted then a completion event is signalled to the upper layer
      by calling the callback handler.</p>
<p class="startli">If the Master is receiving data then the data is read from the FIFO and
      the Master has to request for more data (if there is more data to
      receive). If all the data has been received then a completion event
      is signalled to the upper layer by calling the callback handler.
      It is an error if the amount of received data is more than expected.</p>
</li>
</ul>
</pre><pre><ul>
<li>NAK and SLAVE_RDY
      This is signalled to the upper layer by calling the callback handler.</li>
</ul>
</pre><pre><ul>
<li>All Other interrupts
      These interrupts are marked as error. This is signalled to the upper
      layer by calling the callback handler.</li>
</ul>
</pre><pre></pre><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_iic_ps.html" title="The XIicPs driver instance data. ">XIicPs</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="group__iicps__v3__0.html#ga6809c43387826c1f50e719163d4d9d27">XIicPs_Config::BaseAddress</a>, <a class="el" href="group__iicps__v3__0.html#ga3d97551edd7013b07093cac16dbe80f1">XIICPS_ADDR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#ga11283b281c133a5b15d4da9ce99fa44e">XIICPS_CR_HOLD_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga0c96ab97015c857822df599608ba9c10">XIICPS_CR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#gaaf1867a207f808f18a373435dee8f525">XIICPS_DATA_INTR_DEPTH</a>, <a class="el" href="group__iicps__v3__0.html#gaf7a3f4b57fe275f426ac9b771b187b23">XIicPs_EnableInterrupts</a>, <a class="el" href="group__iicps__v3__0.html#gab784c2ba84387c6a91b0f279065bf396">XIICPS_EVENT_ARB_LOST</a>, <a class="el" href="group__iicps__v3__0.html#ga6aa923029f051dc7a1f8db08cd8691ff">XIICPS_EVENT_COMPLETE_RECV</a>, <a class="el" href="group__iicps__v3__0.html#ga1646c08302f01007599cd95721006d35">XIICPS_EVENT_COMPLETE_SEND</a>, <a class="el" href="group__iicps__v3__0.html#ga60331546be6cd538df23e7ca3e1789fa">XIICPS_EVENT_ERROR</a>, <a class="el" href="group__iicps__v3__0.html#gad72c8977f9bab033f2c393d24a70d5be">XIICPS_EVENT_NACK</a>, <a class="el" href="group__iicps__v3__0.html#ga71fcc8f7c4ee01454f8260667f30ed71">XIICPS_EVENT_SLAVE_RDY</a>, <a class="el" href="group__iicps__v3__0.html#ga609b88168d4a0681b42005e0d402a7eb">XIICPS_FIFO_DEPTH</a>, <a class="el" href="group__iicps__v3__0.html#ga0668ec3389dd427fecfca4d1b9d2f0c4">XIICPS_IMR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#ga9ec604e5ed330606d24a082484e905f0">XIICPS_ISR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#ga88441aea66e1ef8f1fd211756b1d1630">XIICPS_IXR_ARB_LOST_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga56fefd834bba9cc03c0a84bd2a3e099a">XIICPS_IXR_COMP_MASK</a>, <a class="el" href="group__iicps__v3__0.html#gaa4e9c302ebb54b53aa67ec6c9f4616a3">XIICPS_IXR_DATA_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga74650276000c8cc48cce610b8c6d2140">XIICPS_IXR_NACK_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga1f69893ddec793ff77b61deb51665aa5">XIICPS_IXR_RX_OVR_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga6b92f85baedcc73892a141f80afe3462">XIICPS_IXR_RX_UNF_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga5c873e7df9f7a05e458b0d7e9b50faa9">XIICPS_IXR_SLV_RDY_MASK</a>, <a class="el" href="group__iicps__v3__0.html#gad2473caf4558fac9af1bd071a022e3cf">XIICPS_IXR_TX_OVR_MASK</a>, <a class="el" href="group__iicps__v3__0.html#gabcc20fce80c1e8dff27be4e584c2cc27">XIicPs_ReadReg</a>, <a class="el" href="group__iicps__v3__0.html#ga12b4d0ee4dce6172ba78a0dec5666a72">XIICPS_SR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#gafbe8fcac03eab822b049d469485356d0">XIICPS_SR_RXDV_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga2afdc061285f0155f3fbbf322beae54f">XIICPS_TRANS_SIZE_OFFSET</a>, and <a class="el" href="group__iicps__v3__0.html#gaa0bde6894589023ea8248a9d9cdc73c5">XIicPs_WriteReg</a>.</p>

</div>
</div>
<a class="anchor" id="ga4817f45c28341cea4ab8960dc1203acb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XIicPs_MasterRecv </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_iic_ps.html">XIicPs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8 *&#160;</td>
          <td class="paramname"><em>MsgPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">s32&#160;</td>
          <td class="paramname"><em>ByteCount</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>SlaveAddr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8h.html">xiicps.h</a>&gt;</code></p>

<p>This function initiates an interrupt-driven receive in master mode. </p>
<p>It sets the transfer size register so the slave can send data to us. The rest of the work is managed by interrupt handler.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_iic_ps.html" title="The XIicPs driver instance data. ">XIicPs</a> instance. </td></tr>
    <tr><td class="paramname">MsgPtr</td><td>is the pointer to the receive buffer. </td></tr>
    <tr><td class="paramname">ByteCount</td><td>is the number of bytes to be received. </td></tr>
    <tr><td class="paramname">SlaveAddr</td><td>is the address of the slave we are receiving from.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This receive routine is for interrupt-driven transfer only. </dd></dl>

<p>References <a class="el" href="group__iicps__v3__0.html#ga6809c43387826c1f50e719163d4d9d27">XIicPs_Config::BaseAddress</a>, <a class="el" href="group__iicps__v3__0.html#ga9cfa5c76753b0658954c2c3dfec95d40">RECVING_ROLE</a>, <a class="el" href="group__iicps__v3__0.html#ga65d613d28fe2707d6e1d0fb2ea5b0d9e">XIICPS_ADDR_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga3d97551edd7013b07093cac16dbe80f1">XIICPS_ADDR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#ga11283b281c133a5b15d4da9ce99fa44e">XIICPS_CR_HOLD_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga0c96ab97015c857822df599608ba9c10">XIICPS_CR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#gaf7a3f4b57fe275f426ac9b771b187b23">XIicPs_EnableInterrupts</a>, <a class="el" href="group__iicps__v3__0.html#ga609b88168d4a0681b42005e0d402a7eb">XIICPS_FIFO_DEPTH</a>, <a class="el" href="group__iicps__v3__0.html#ga88441aea66e1ef8f1fd211756b1d1630">XIICPS_IXR_ARB_LOST_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga56fefd834bba9cc03c0a84bd2a3e099a">XIICPS_IXR_COMP_MASK</a>, <a class="el" href="group__iicps__v3__0.html#gaa4e9c302ebb54b53aa67ec6c9f4616a3">XIICPS_IXR_DATA_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga74650276000c8cc48cce610b8c6d2140">XIICPS_IXR_NACK_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga1f69893ddec793ff77b61deb51665aa5">XIICPS_IXR_RX_OVR_MASK</a>, <a class="el" href="group__iicps__v3__0.html#gabcc20fce80c1e8dff27be4e584c2cc27">XIicPs_ReadReg</a>, <a class="el" href="group__iicps__v3__0.html#ga2afdc061285f0155f3fbbf322beae54f">XIICPS_TRANS_SIZE_OFFSET</a>, and <a class="el" href="group__iicps__v3__0.html#gaa0bde6894589023ea8248a9d9cdc73c5">XIicPs_WriteReg</a>.</p>

</div>
</div>
<a class="anchor" id="ga21bdb2f8a1f09e027aa8b0e9d6648d75"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">s32 XIicPs_MasterRecvPolled </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_iic_ps.html">XIicPs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8 *&#160;</td>
          <td class="paramname"><em>MsgPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">s32&#160;</td>
          <td class="paramname"><em>ByteCount</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>SlaveAddr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8h.html">xiicps.h</a>&gt;</code></p>

<p>This function initiates a polled mode receive in master mode. </p>
<p>It repeatedly sets the transfer size register so the slave can send data to us. It polls the data register for data to come in. If slave fails to send us data, it fails with time out.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_iic_ps.html" title="The XIicPs driver instance data. ">XIicPs</a> instance. </td></tr>
    <tr><td class="paramname">MsgPtr</td><td>is the pointer to the receive buffer. </td></tr>
    <tr><td class="paramname">ByteCount</td><td>is the number of bytes to be received. </td></tr>
    <tr><td class="paramname">SlaveAddr</td><td>is the address of the slave we are receiving from.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if everything went well.</li>
<li>XST_FAILURE if timed out.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This receive routine is for polled mode transfer only. </dd></dl>

<p>References <a class="el" href="group__iicps__v3__0.html#ga6809c43387826c1f50e719163d4d9d27">XIicPs_Config::BaseAddress</a>, <a class="el" href="group__iicps__v3__0.html#ga9cfa5c76753b0658954c2c3dfec95d40">RECVING_ROLE</a>, <a class="el" href="group__iicps__v3__0.html#ga65d613d28fe2707d6e1d0fb2ea5b0d9e">XIICPS_ADDR_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga3d97551edd7013b07093cac16dbe80f1">XIICPS_ADDR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#ga11283b281c133a5b15d4da9ce99fa44e">XIICPS_CR_HOLD_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga0c96ab97015c857822df599608ba9c10">XIICPS_CR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#gaaf1867a207f808f18a373435dee8f525">XIICPS_DATA_INTR_DEPTH</a>, <a class="el" href="group__iicps__v3__0.html#ga609b88168d4a0681b42005e0d402a7eb">XIICPS_FIFO_DEPTH</a>, <a class="el" href="group__iicps__v3__0.html#ga9ec604e5ed330606d24a082484e905f0">XIICPS_ISR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#ga88441aea66e1ef8f1fd211756b1d1630">XIICPS_IXR_ARB_LOST_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga74650276000c8cc48cce610b8c6d2140">XIICPS_IXR_NACK_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga1f69893ddec793ff77b61deb51665aa5">XIICPS_IXR_RX_OVR_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga6b92f85baedcc73892a141f80afe3462">XIICPS_IXR_RX_UNF_MASK</a>, <a class="el" href="group__iicps__v3__0.html#gabcc20fce80c1e8dff27be4e584c2cc27">XIicPs_ReadReg</a>, <a class="el" href="group__iicps__v3__0.html#ga12b4d0ee4dce6172ba78a0dec5666a72">XIICPS_SR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#gafbe8fcac03eab822b049d469485356d0">XIICPS_SR_RXDV_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga2afdc061285f0155f3fbbf322beae54f">XIICPS_TRANS_SIZE_OFFSET</a>, and <a class="el" href="group__iicps__v3__0.html#gaa0bde6894589023ea8248a9d9cdc73c5">XIicPs_WriteReg</a>.</p>

</div>
</div>
<a class="anchor" id="ga3027c1eb6ece3193a978a2da8e06c011"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XIicPs_MasterSend </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_iic_ps.html">XIicPs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8 *&#160;</td>
          <td class="paramname"><em>MsgPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">s32&#160;</td>
          <td class="paramname"><em>ByteCount</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>SlaveAddr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8h.html">xiicps.h</a>&gt;</code></p>

<p>This function initiates an interrupt-driven send in master mode. </p>
<p>It tries to send the first FIFO-full of data, then lets the interrupt handler to handle the rest of the data if there is any.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_iic_ps.html" title="The XIicPs driver instance data. ">XIicPs</a> instance. </td></tr>
    <tr><td class="paramname">MsgPtr</td><td>is the pointer to the send buffer. </td></tr>
    <tr><td class="paramname">ByteCount</td><td>is the number of bytes to be sent. </td></tr>
    <tr><td class="paramname">SlaveAddr</td><td>is the address of the slave we are sending to.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This send routine is for interrupt-driven transfer only. </dd></dl>

<p>References <a class="el" href="group__iicps__v3__0.html#ga6809c43387826c1f50e719163d4d9d27">XIicPs_Config::BaseAddress</a>, <a class="el" href="group__iicps__v3__0.html#ga80e3362dd68172d429bb9361768d09e7">SENDING_ROLE</a>, <a class="el" href="group__iicps__v3__0.html#gacfb0d8f18f8105db7708669ddb186e19">TransmitFifoFill()</a>, <a class="el" href="group__iicps__v3__0.html#ga65d613d28fe2707d6e1d0fb2ea5b0d9e">XIICPS_ADDR_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga3d97551edd7013b07093cac16dbe80f1">XIICPS_ADDR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#ga11283b281c133a5b15d4da9ce99fa44e">XIICPS_CR_HOLD_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga0c96ab97015c857822df599608ba9c10">XIICPS_CR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#gaf7a3f4b57fe275f426ac9b771b187b23">XIicPs_EnableInterrupts</a>, <a class="el" href="group__iicps__v3__0.html#ga609b88168d4a0681b42005e0d402a7eb">XIICPS_FIFO_DEPTH</a>, <a class="el" href="group__iicps__v3__0.html#ga88441aea66e1ef8f1fd211756b1d1630">XIICPS_IXR_ARB_LOST_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga56fefd834bba9cc03c0a84bd2a3e099a">XIICPS_IXR_COMP_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga74650276000c8cc48cce610b8c6d2140">XIICPS_IXR_NACK_MASK</a>, <a class="el" href="group__iicps__v3__0.html#gabcc20fce80c1e8dff27be4e584c2cc27">XIicPs_ReadReg</a>, and <a class="el" href="group__iicps__v3__0.html#gaa0bde6894589023ea8248a9d9cdc73c5">XIicPs_WriteReg</a>.</p>

</div>
</div>
<a class="anchor" id="ga71584f1a7e675cde41cfd9d1bd4320b4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">s32 XIicPs_MasterSendPolled </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_iic_ps.html">XIicPs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8 *&#160;</td>
          <td class="paramname"><em>MsgPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">s32&#160;</td>
          <td class="paramname"><em>ByteCount</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>SlaveAddr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8h.html">xiicps.h</a>&gt;</code></p>

<p>This function initiates a polled mode send in master mode. </p>
<p>It sends data to the FIFO and waits for the slave to pick them up. If slave fails to remove data from FIFO, the send fails with time out.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_iic_ps.html" title="The XIicPs driver instance data. ">XIicPs</a> instance. </td></tr>
    <tr><td class="paramname">MsgPtr</td><td>is the pointer to the send buffer. </td></tr>
    <tr><td class="paramname">ByteCount</td><td>is the number of bytes to be sent. </td></tr>
    <tr><td class="paramname">SlaveAddr</td><td>is the address of the slave we are sending to.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if everything went well.</li>
<li>XST_FAILURE if timed out.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This send routine is for polled mode transfer only. </dd></dl>

<p>References <a class="el" href="group__iicps__v3__0.html#ga6809c43387826c1f50e719163d4d9d27">XIicPs_Config::BaseAddress</a>, <a class="el" href="group__iicps__v3__0.html#ga80e3362dd68172d429bb9361768d09e7">SENDING_ROLE</a>, <a class="el" href="group__iicps__v3__0.html#gacfb0d8f18f8105db7708669ddb186e19">TransmitFifoFill()</a>, <a class="el" href="group__iicps__v3__0.html#ga65d613d28fe2707d6e1d0fb2ea5b0d9e">XIICPS_ADDR_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga3d97551edd7013b07093cac16dbe80f1">XIICPS_ADDR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#ga11283b281c133a5b15d4da9ce99fa44e">XIICPS_CR_HOLD_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga0c96ab97015c857822df599608ba9c10">XIICPS_CR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#ga609b88168d4a0681b42005e0d402a7eb">XIICPS_FIFO_DEPTH</a>, <a class="el" href="group__iicps__v3__0.html#ga9ec604e5ed330606d24a082484e905f0">XIICPS_ISR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#ga88441aea66e1ef8f1fd211756b1d1630">XIICPS_IXR_ARB_LOST_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga56fefd834bba9cc03c0a84bd2a3e099a">XIICPS_IXR_COMP_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga74650276000c8cc48cce610b8c6d2140">XIICPS_IXR_NACK_MASK</a>, <a class="el" href="group__iicps__v3__0.html#gad2473caf4558fac9af1bd071a022e3cf">XIICPS_IXR_TX_OVR_MASK</a>, <a class="el" href="group__iicps__v3__0.html#gabcc20fce80c1e8dff27be4e584c2cc27">XIicPs_ReadReg</a>, <a class="el" href="group__iicps__v3__0.html#ga12b4d0ee4dce6172ba78a0dec5666a72">XIICPS_SR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#ga4ec47ab77103b89564d25650fee6132f">XIICPS_SR_TXDV_MASK</a>, and <a class="el" href="group__iicps__v3__0.html#gaa0bde6894589023ea8248a9d9cdc73c5">XIicPs_WriteReg</a>.</p>

</div>
</div>
<a class="anchor" id="ga1169a92eb8594d6f038816b5740916f7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XIicPs_Reset </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_iic_ps.html">XIicPs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8c.html">xiicps.c</a>&gt;</code></p>

<p>Resets the IIC device. </p>
<p>Reset must only be called after the driver has been initialized. The configuration of the device after reset is the same as its configuration after initialization. Any data transfer that is in progress is aborted.</p>
<p>The upper layer software is responsible for re-configuring (if necessary) and reenabling interrupts for the IIC device after the reset.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_iic_ps.html" title="The XIicPs driver instance data. ">XIicPs</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="group__iicps__v3__0.html#ga6809c43387826c1f50e719163d4d9d27">XIicPs_Config::BaseAddress</a>, <a class="el" href="group__iicps__v3__0.html#ga3eaa694ecd774beca05bf79c1f9df6c0">XIicPs_Abort()</a>, <a class="el" href="group__iicps__v3__0.html#ga0c96ab97015c857822df599608ba9c10">XIICPS_CR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#ga42b856fa59af3400a93291cf0e652307">XIICPS_CR_RESET_VALUE</a>, <a class="el" href="group__iicps__v3__0.html#gac95b4e2bd04257b322e5bf66f956bdf3">XIICPS_IDR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#ga8e324637da3483d518d499b7257c7631">XIICPS_IXR_ALL_INTR_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga61f5015241d07352f5cad00c589ec4e0">XIICPS_TIME_OUT_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#gafbad4feee5924c925b1fe0d864c3799a">XIICPS_TO_RESET_VALUE</a>, and <a class="el" href="group__iicps__v3__0.html#gaa0bde6894589023ea8248a9d9cdc73c5">XIicPs_WriteReg</a>.</p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#gae97ad9c202953c7e49bfb56533c47079">XIicPs_CfgInitialize()</a>, and <a class="el" href="group__iicps__v3__0.html#ga6f9db7651cd6ee0232dc9fdaca3f976a">XIicPs_SelfTest()</a>.</p>

</div>
</div>
<a class="anchor" id="gabfedbe03a6ac7de3d4e0ac192b8ab288"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XIicPs_ResetHw </td>
          <td>(</td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>BaseAddress</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__hw_8c.html">xiicps_hw.c</a>&gt;</code></p>

<p>This function perform the reset sequence to the given I2c interface by configuring the appropriate control bits in the I2c specifc registers the i2cps reset squence involves the following steps Disable all the interuupts Clear the status Clear FIFO's and disable hold bit Clear the line status Update relevant config registers with reset values. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BaseAddress</td><td>of the interface</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>N/A</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This function will not modify the slcr registers that are relavant for I2c controller </dd></dl>

<p>References <a class="el" href="group__iicps__v3__0.html#ga8eca5ebddd70579d4ecc3af1df21f4bf">XIICPS_CR_ACKEN_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga167d2a48ba5ab4cdf58f229bf6a0b554">XIICPS_CR_CLR_FIFO_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga11283b281c133a5b15d4da9ce99fa44e">XIICPS_CR_HOLD_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga77c04588069ca5f72be4e8177ff6c0d8">XIICPS_CR_MS_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga0c96ab97015c857822df599608ba9c10">XIICPS_CR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#gac95b4e2bd04257b322e5bf66f956bdf3">XIICPS_IDR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#ga9ec604e5ed330606d24a082484e905f0">XIICPS_ISR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#ga8e324637da3483d518d499b7257c7631">XIICPS_IXR_ALL_INTR_MASK</a>, <a class="el" href="group__iicps__v3__0.html#gabcc20fce80c1e8dff27be4e584c2cc27">XIicPs_ReadReg</a>, <a class="el" href="group__iicps__v3__0.html#ga12b4d0ee4dce6172ba78a0dec5666a72">XIICPS_SR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#ga61f5015241d07352f5cad00c589ec4e0">XIICPS_TIME_OUT_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#gafbad4feee5924c925b1fe0d864c3799a">XIICPS_TO_RESET_VALUE</a>, <a class="el" href="group__iicps__v3__0.html#ga2afdc061285f0155f3fbbf322beae54f">XIICPS_TRANS_SIZE_OFFSET</a>, and <a class="el" href="group__iicps__v3__0.html#gaa0bde6894589023ea8248a9d9cdc73c5">XIicPs_WriteReg</a>.</p>

</div>
</div>
<a class="anchor" id="ga6f9db7651cd6ee0232dc9fdaca3f976a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">s32 XIicPs_SelfTest </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_iic_ps.html">XIicPs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8h.html">xiicps.h</a>&gt;</code></p>

<p>Runs a self-test on the driver/device. </p>
<p>The self-test is destructive in that a reset of the device is performed in order to check the reset values of the registers and to get the device into a known state.</p>
<p>Upon successful return from the self-test, the device is reset.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_iic_ps.html" title="The XIicPs driver instance data. ">XIicPs</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if successful.</li>
<li>XST_REGISTER_ERROR indicates a register did not read or write correctly</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="group__iicps__v3__0.html#ga6809c43387826c1f50e719163d4d9d27">XIicPs_Config::BaseAddress</a>, <a class="el" href="group__iicps__v3__0.html#ga0c96ab97015c857822df599608ba9c10">XIICPS_CR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#ga42b856fa59af3400a93291cf0e652307">XIICPS_CR_RESET_VALUE</a>, <a class="el" href="group__iicps__v3__0.html#ga0668ec3389dd427fecfca4d1b9d2f0c4">XIICPS_IMR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#ga8e324637da3483d518d499b7257c7631">XIICPS_IXR_ALL_INTR_MASK</a>, <a class="el" href="group__iicps__v3__0.html#gabcc20fce80c1e8dff27be4e584c2cc27">XIicPs_ReadReg</a>, <a class="el" href="group__iicps__v3__0.html#ga1169a92eb8594d6f038816b5740916f7">XIicPs_Reset()</a>, <a class="el" href="group__iicps__v3__0.html#ga3750481db8ebadadea48985f0abcb755">XIICPS_SLV_PAUSE_OFFSET</a>, and <a class="el" href="group__iicps__v3__0.html#gaa0bde6894589023ea8248a9d9cdc73c5">XIicPs_WriteReg</a>.</p>

</div>
</div>
<a class="anchor" id="gaec1dc5be2be8a7394263cfe56af976c5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">s32 XIicPs_SetOptions </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_iic_ps.html">XIicPs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>Options</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8h.html">xiicps.h</a>&gt;</code></p>

<p>This function sets the options for the IIC device driver. </p>
<p>The options control how the device behaves relative to the IIC bus. The device must be idle rather than busy transferring data before setting these device options.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_iic_ps.html" title="The XIicPs driver instance data. ">XIicPs</a> instance. </td></tr>
    <tr><td class="paramname">Options</td><td>contains the specified options to be set. This is a bit mask where a 1 means to turn the option on. One or more bit values may be contained in the mask. See the bit definitions named XIICPS_*_OPTION in <a class="el" href="xiicps_8h.html">xiicps.h</a>.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if options are successfully set.</li>
<li>XST_DEVICE_IS_STARTED if the device is currently transferring data. The transfer must complete or be aborted before setting options.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="group__iicps__v3__0.html#ga6809c43387826c1f50e719163d4d9d27">XIicPs_Config::BaseAddress</a>, <a class="el" href="group__iicps__v3__0.html#ga4057e55c42ab0d06b32c55d5e67e0029">XIICPS_10_BIT_ADDR_OPTION</a>, <a class="el" href="group__iicps__v3__0.html#ga0c96ab97015c857822df599608ba9c10">XIICPS_CR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#ga20964e35a74f4e16f90e78510c9b4337">XIicPs_GetOptions()</a>, <a class="el" href="group__iicps__v3__0.html#gabcc20fce80c1e8dff27be4e584c2cc27">XIicPs_ReadReg</a>, <a class="el" href="group__iicps__v3__0.html#ga820f2cd7e2c7b77b9b5966e87eae2c09">XIICPS_REP_START_OPTION</a>, and <a class="el" href="group__iicps__v3__0.html#gaa0bde6894589023ea8248a9d9cdc73c5">XIicPs_WriteReg</a>.</p>

</div>
</div>
<a class="anchor" id="gafb24cfdacf6cf28d80126862dc1cfbe5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">s32 XIicPs_SetSClk </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_iic_ps.html">XIicPs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>FsclHz</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8h.html">xiicps.h</a>&gt;</code></p>

<p>This function sets the serial clock rate for the IIC device. </p>
<p>The device must be idle rather than busy transferring data before setting these device options.</p>
<p>The data rate is set by values in the control register. The formula for determining the correct register values is: Fscl = Fpclk/(22 x (divisor_a+1) x (divisor_b+1)) See the hardware data sheet for a full explanation of setting the serial clock rate.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_iic_ps.html" title="The XIicPs driver instance data. ">XIicPs</a> instance. </td></tr>
    <tr><td class="paramname">FsclHz</td><td>is the clock frequency in Hz. The two most common clock rates are 100KHz and 400KHz.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if options are successfully set.</li>
<li>XST_DEVICE_IS_STARTED if the device is currently transferring data. The transfer must complete or be aborted before setting options.</li>
<li>XST_FAILURE if the Fscl frequency can not be set.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>The clock can not be faster than the input clock divide by 22. </dd></dl>

<p>References <a class="el" href="group__iicps__v3__0.html#ga6809c43387826c1f50e719163d4d9d27">XIicPs_Config::BaseAddress</a>, <a class="el" href="group__iicps__v3__0.html#gafbb42f3963d40b41b322b76c88dcd916">XIicPs_Config::InputClockHz</a>, <a class="el" href="group__iicps__v3__0.html#gae1eb58bcf8d77fd6a8f9325d5344b390">XIICPS_CR_DIV_A_MASK</a>, <a class="el" href="group__iicps__v3__0.html#gae980b732a8b41e97461d097cdca82d38">XIICPS_CR_DIV_A_SHIFT</a>, <a class="el" href="group__iicps__v3__0.html#gaee06a0e2ceece45ef3ca15fffacbaac3">XIICPS_CR_DIV_B_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga0475ff513956035cd712dd4ee3301364">XIICPS_CR_DIV_B_SHIFT</a>, <a class="el" href="group__iicps__v3__0.html#ga0c96ab97015c857822df599608ba9c10">XIICPS_CR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#gabcc20fce80c1e8dff27be4e584c2cc27">XIicPs_ReadReg</a>, <a class="el" href="group__iicps__v3__0.html#ga2afdc061285f0155f3fbbf322beae54f">XIICPS_TRANS_SIZE_OFFSET</a>, and <a class="el" href="group__iicps__v3__0.html#gaa0bde6894589023ea8248a9d9cdc73c5">XIicPs_WriteReg</a>.</p>

</div>
</div>
<a class="anchor" id="gab2581047e7d5607fe96fe0dac9673527"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XIicPs_SetStatusHandler </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_iic_ps.html">XIicPs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>CallBackRef</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__iicps__v3__0.html#gaabcfd3b5d9ed949a553a992242237cba">XIicPs_IntrHandler</a>&#160;</td>
          <td class="paramname"><em>FunctionPtr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8h.html">xiicps.h</a>&gt;</code></p>

<p>This function sets the status callback function, the status handler, which the driver calls when it encounters conditions that should be reported to the higher layer software. </p>
<p>The handler executes in an interrupt context, so the amount of processing should be minimized</p>
<p>Refer to the <a class="el" href="xiicps_8h.html">xiicps.h</a> file for a list of the Callback events. The events are defined to start with XIICPS_EVENT_*.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_iic_ps.html" title="The XIicPs driver instance data. ">XIicPs</a> instance. </td></tr>
    <tr><td class="paramname">CallBackRef</td><td>is the upper layer callback reference passed back when the callback function is invoked. </td></tr>
    <tr><td class="paramname">FunctionPtr</td><td>is the pointer to the callback function.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd></dd></dl>
<p>The handler is called within interrupt context, so it should finish its work quickly. </p>

</div>
</div>
<a class="anchor" id="gad1c7ffa09df93fb59f97b0a3bf5baaa7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XIicPs_SetupSlave </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_iic_ps.html">XIicPs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>SlaveAddr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8h.html">xiicps.h</a>&gt;</code></p>

<p>This function sets up the device to be a slave. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_iic_ps.html" title="The XIicPs driver instance data. ">XIicPs</a> instance. </td></tr>
    <tr><td class="paramname">SlaveAddr</td><td>is the address of the slave we are receiving from.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Interrupt is always enabled no matter the tranfer is interrupt- driven or polled mode. Whether device will be interrupted or not depends on whether the device is connected to an interrupt controller and interrupt for the device is enabled. </dd></dl>

<p>References <a class="el" href="group__iicps__v3__0.html#ga6809c43387826c1f50e719163d4d9d27">XIicPs_Config::BaseAddress</a>, <a class="el" href="group__iicps__v3__0.html#ga65d613d28fe2707d6e1d0fb2ea5b0d9e">XIICPS_ADDR_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga3d97551edd7013b07093cac16dbe80f1">XIICPS_ADDR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#ga8eca5ebddd70579d4ecc3af1df21f4bf">XIICPS_CR_ACKEN_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga167d2a48ba5ab4cdf58f229bf6a0b554">XIICPS_CR_CLR_FIFO_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga77c04588069ca5f72be4e8177ff6c0d8">XIICPS_CR_MS_MASK</a>, <a class="el" href="group__iicps__v3__0.html#gada95425b2ab9cb404dcdc418d667370c">XIICPS_CR_NEA_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga0c96ab97015c857822df599608ba9c10">XIICPS_CR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#ga90efda2a784d4b972f1835b0ba81cde1">XIicPs_DisableAllInterrupts</a>, and <a class="el" href="group__iicps__v3__0.html#gaa0bde6894589023ea8248a9d9cdc73c5">XIicPs_WriteReg</a>.</p>

</div>
</div>
<a class="anchor" id="ga716cdb9f63e56269824866872958dd78"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XIicPs_SlaveInterruptHandler </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_iic_ps.html">XIicPs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8h.html">xiicps.h</a>&gt;</code></p>

<p>The interrupt handler for slave mode. </p>
<p>It does the protocol handling for the interrupt-driven transfers.</p>
<p>Completion events and errors are signaled to upper layer for proper handling.</p>
<pre></pre><pre>The interrupts that are handled are:</p><ul>
<li><p class="startli">DATA
      If the instance is sending, it means that the master wants to read more
      data from us. Send more data, and check whether we are done with this
      send.</p>
<p class="startli">If the instance is receiving, it means that the master has writen
	more data to us. Receive more data, and check whether we are done with
      with this receive.</p>
</li>
</ul>
</pre><pre><ul>
<li><p class="startli">COMP
      This marks that stop sequence has been sent from the master, transfer
      is about to terminate. However, for receiving, the master may have
      written us some data, so receive that first.</p>
<p class="startli">It is an error if the amount of transfered data is less than expected.</p>
</li>
</ul>
</pre><pre><ul>
<li>NAK
      This marks that master does not want our data. It is for send only.</li>
</ul>
</pre><pre><ul>
<li>Other interrupts
      These interrupts are marked as error.</li>
</ul>
</pre><pre></pre><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_iic_ps.html" title="The XIicPs driver instance data. ">XIicPs</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="group__iicps__v3__0.html#ga6809c43387826c1f50e719163d4d9d27">XIicPs_Config::BaseAddress</a>, <a class="el" href="group__iicps__v3__0.html#gacfb0d8f18f8105db7708669ddb186e19">TransmitFifoFill()</a>, <a class="el" href="group__iicps__v3__0.html#ga6aa923029f051dc7a1f8db08cd8691ff">XIICPS_EVENT_COMPLETE_RECV</a>, <a class="el" href="group__iicps__v3__0.html#ga1646c08302f01007599cd95721006d35">XIICPS_EVENT_COMPLETE_SEND</a>, <a class="el" href="group__iicps__v3__0.html#ga60331546be6cd538df23e7ca3e1789fa">XIICPS_EVENT_ERROR</a>, <a class="el" href="group__iicps__v3__0.html#gad72c8977f9bab033f2c393d24a70d5be">XIICPS_EVENT_NACK</a>, <a class="el" href="group__iicps__v3__0.html#ga0668ec3389dd427fecfca4d1b9d2f0c4">XIICPS_IMR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#ga9ec604e5ed330606d24a082484e905f0">XIICPS_ISR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#ga56fefd834bba9cc03c0a84bd2a3e099a">XIICPS_IXR_COMP_MASK</a>, <a class="el" href="group__iicps__v3__0.html#gaa4e9c302ebb54b53aa67ec6c9f4616a3">XIICPS_IXR_DATA_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga74650276000c8cc48cce610b8c6d2140">XIICPS_IXR_NACK_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga1f69893ddec793ff77b61deb51665aa5">XIICPS_IXR_RX_OVR_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga6b92f85baedcc73892a141f80afe3462">XIICPS_IXR_RX_UNF_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga6df84833528a63b5f5fb07a7d1743c91">XIICPS_IXR_TO_MASK</a>, <a class="el" href="group__iicps__v3__0.html#gad2473caf4558fac9af1bd071a022e3cf">XIICPS_IXR_TX_OVR_MASK</a>, <a class="el" href="group__iicps__v3__0.html#gabcc20fce80c1e8dff27be4e584c2cc27">XIicPs_ReadReg</a>, and <a class="el" href="group__iicps__v3__0.html#gaa0bde6894589023ea8248a9d9cdc73c5">XIicPs_WriteReg</a>.</p>

</div>
</div>
<a class="anchor" id="ga1840936a940459c5a71858f94915f933"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XIicPs_SlaveRecv </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_iic_ps.html">XIicPs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8 *&#160;</td>
          <td class="paramname"><em>MsgPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">s32&#160;</td>
          <td class="paramname"><em>ByteCount</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8h.html">xiicps.h</a>&gt;</code></p>

<p>This function setup a slave interrupt-driven receive. </p>
<p>Data processing for the receive is handled by the interrupt handler.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_iic_ps.html" title="The XIicPs driver instance data. ">XIicPs</a> instance. </td></tr>
    <tr><td class="paramname">MsgPtr</td><td>is the pointer to the receive buffer. </td></tr>
    <tr><td class="paramname">ByteCount</td><td>is the number of bytes to be received.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This routine is for interrupt-driven transfer only. </dd></dl>

<p>References <a class="el" href="group__iicps__v3__0.html#ga6809c43387826c1f50e719163d4d9d27">XIicPs_Config::BaseAddress</a>, <a class="el" href="group__iicps__v3__0.html#gaf7a3f4b57fe275f426ac9b771b187b23">XIicPs_EnableInterrupts</a>, <a class="el" href="group__iicps__v3__0.html#ga56fefd834bba9cc03c0a84bd2a3e099a">XIICPS_IXR_COMP_MASK</a>, <a class="el" href="group__iicps__v3__0.html#gaa4e9c302ebb54b53aa67ec6c9f4616a3">XIICPS_IXR_DATA_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga74650276000c8cc48cce610b8c6d2140">XIICPS_IXR_NACK_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga1f69893ddec793ff77b61deb51665aa5">XIICPS_IXR_RX_OVR_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga6b92f85baedcc73892a141f80afe3462">XIICPS_IXR_RX_UNF_MASK</a>, and <a class="el" href="group__iicps__v3__0.html#ga6df84833528a63b5f5fb07a7d1743c91">XIICPS_IXR_TO_MASK</a>.</p>

</div>
</div>
<a class="anchor" id="ga74b0af9e4395c8de724dc377e3504d0d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">s32 XIicPs_SlaveRecvPolled </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_iic_ps.html">XIicPs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8 *&#160;</td>
          <td class="paramname"><em>MsgPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">s32&#160;</td>
          <td class="paramname"><em>ByteCount</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8h.html">xiicps.h</a>&gt;</code></p>

<p>This function receives a buffer in polled mode as a slave. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_iic_ps.html" title="The XIicPs driver instance data. ">XIicPs</a> instance. </td></tr>
    <tr><td class="paramname">MsgPtr</td><td>is the pointer to the receive buffer. </td></tr>
    <tr><td class="paramname">ByteCount</td><td>is the number of bytes to be received.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if everything went well.</li>
<li>XST_FAILURE if timed out.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This receive routine is for polled mode transfer only. </dd></dl>

<p>References <a class="el" href="group__iicps__v3__0.html#ga6809c43387826c1f50e719163d4d9d27">XIicPs_Config::BaseAddress</a>, <a class="el" href="group__iicps__v3__0.html#ga9ec604e5ed330606d24a082484e905f0">XIICPS_ISR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#ga56fefd834bba9cc03c0a84bd2a3e099a">XIICPS_IXR_COMP_MASK</a>, <a class="el" href="group__iicps__v3__0.html#gaa4e9c302ebb54b53aa67ec6c9f4616a3">XIICPS_IXR_DATA_MASK</a>, <a class="el" href="group__iicps__v3__0.html#gabcc20fce80c1e8dff27be4e584c2cc27">XIicPs_ReadReg</a>, <a class="el" href="group__iicps__v3__0.html#ga12b4d0ee4dce6172ba78a0dec5666a72">XIICPS_SR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#gafbe8fcac03eab822b049d469485356d0">XIICPS_SR_RXDV_MASK</a>, and <a class="el" href="group__iicps__v3__0.html#gaa0bde6894589023ea8248a9d9cdc73c5">XIicPs_WriteReg</a>.</p>

</div>
</div>
<a class="anchor" id="ga4478d1d94f349deda02c0191a7529113"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XIicPs_SlaveSend </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_iic_ps.html">XIicPs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8 *&#160;</td>
          <td class="paramname"><em>MsgPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">s32&#160;</td>
          <td class="paramname"><em>ByteCount</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8h.html">xiicps.h</a>&gt;</code></p>

<p>This function setup a slave interrupt-driven send. </p>
<p>It set the repeated start for the device is the tranfer size is larger than FIFO depth. Data processing for the send is initiated by the interrupt handler.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_iic_ps.html" title="The XIicPs driver instance data. ">XIicPs</a> instance. </td></tr>
    <tr><td class="paramname">MsgPtr</td><td>is the pointer to the send buffer. </td></tr>
    <tr><td class="paramname">ByteCount</td><td>is the number of bytes to be sent.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This send routine is for interrupt-driven transfer only. </dd></dl>

<p>References <a class="el" href="group__iicps__v3__0.html#ga6809c43387826c1f50e719163d4d9d27">XIicPs_Config::BaseAddress</a>, <a class="el" href="group__iicps__v3__0.html#gaf7a3f4b57fe275f426ac9b771b187b23">XIicPs_EnableInterrupts</a>, <a class="el" href="group__iicps__v3__0.html#ga56fefd834bba9cc03c0a84bd2a3e099a">XIICPS_IXR_COMP_MASK</a>, <a class="el" href="group__iicps__v3__0.html#gaa4e9c302ebb54b53aa67ec6c9f4616a3">XIICPS_IXR_DATA_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga74650276000c8cc48cce610b8c6d2140">XIICPS_IXR_NACK_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga6df84833528a63b5f5fb07a7d1743c91">XIICPS_IXR_TO_MASK</a>, and <a class="el" href="group__iicps__v3__0.html#gad2473caf4558fac9af1bd071a022e3cf">XIICPS_IXR_TX_OVR_MASK</a>.</p>

</div>
</div>
<a class="anchor" id="ga5ca49d9131b13d66f58de0b5a23faea4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">s32 XIicPs_SlaveSendPolled </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_iic_ps.html">XIicPs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8 *&#160;</td>
          <td class="paramname"><em>MsgPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">s32&#160;</td>
          <td class="paramname"><em>ByteCount</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps_8h.html">xiicps.h</a>&gt;</code></p>

<p>This function sends a buffer in polled mode as a slave. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_iic_ps.html" title="The XIicPs driver instance data. ">XIicPs</a> instance. </td></tr>
    <tr><td class="paramname">MsgPtr</td><td>is the pointer to the send buffer. </td></tr>
    <tr><td class="paramname">ByteCount</td><td>is the number of bytes to be sent.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if everything went well.</li>
<li>XST_FAILURE if master sends us data or master terminates the transfer before all data has sent out.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This send routine is for polled mode transfer only. </dd></dl>

<p>References <a class="el" href="group__iicps__v3__0.html#ga6809c43387826c1f50e719163d4d9d27">XIicPs_Config::BaseAddress</a>, <a class="el" href="group__iicps__v3__0.html#ga609b88168d4a0681b42005e0d402a7eb">XIICPS_FIFO_DEPTH</a>, <a class="el" href="group__iicps__v3__0.html#ga9ec604e5ed330606d24a082484e905f0">XIICPS_ISR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#ga74650276000c8cc48cce610b8c6d2140">XIICPS_IXR_NACK_MASK</a>, <a class="el" href="group__iicps__v3__0.html#gabcc20fce80c1e8dff27be4e584c2cc27">XIicPs_ReadReg</a>, <a class="el" href="group__iicps__v3__0.html#ga12b4d0ee4dce6172ba78a0dec5666a72">XIICPS_SR_OFFSET</a>, <a class="el" href="group__iicps__v3__0.html#gafbe8fcac03eab822b049d469485356d0">XIICPS_SR_RXDV_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga694b3781a9539f3c34b97a4d58b68efd">XIICPS_SR_RXRW_MASK</a>, <a class="el" href="group__iicps__v3__0.html#ga4ec47ab77103b89564d25650fee6132f">XIICPS_SR_TXDV_MASK</a>, and <a class="el" href="group__iicps__v3__0.html#gaa0bde6894589023ea8248a9d9cdc73c5">XIicPs_WriteReg</a>.</p>

</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a class="anchor" id="ga6809c43387826c1f50e719163d4d9d27"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XIicPs_Config::BaseAddress</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Base address of the device. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#gacfb0d8f18f8105db7708669ddb186e19">TransmitFifoFill()</a>, <a class="el" href="group__iicps__v3__0.html#ga3eaa694ecd774beca05bf79c1f9df6c0">XIicPs_Abort()</a>, <a class="el" href="group__iicps__v3__0.html#ga5b67ad96b8c40bdd47c2c2f8a57f170c">XIicPs_BusIsBusy()</a>, <a class="el" href="group__iicps__v3__0.html#gae97ad9c202953c7e49bfb56533c47079">XIicPs_CfgInitialize()</a>, <a class="el" href="group__iicps__v3__0.html#ga87cbf2622a9c6ad66b18d4c3f9575a76">XIicPs_ClearOptions()</a>, <a class="el" href="group__iicps__v3__0.html#ga15f2e8071ff8d8e1ec1dc56d29ab202b">XIicPs_DisableSlaveMonitor()</a>, <a class="el" href="group__iicps__v3__0.html#ga597faa64ccaf3d8034e3e92989048f06">XIicPs_EnableSlaveMonitor()</a>, <a class="el" href="group__iicps__v3__0.html#ga20964e35a74f4e16f90e78510c9b4337">XIicPs_GetOptions()</a>, <a class="el" href="group__iicps__v3__0.html#ga9f2d2d3d11c2c9125a5bc8a0d95593cb">XIicPs_GetSClk()</a>, <a class="el" href="group__iicps__v3__0.html#gad64f0389aa694ecf21ca8a39e44cf13f">XIicPs_MasterInterruptHandler()</a>, <a class="el" href="group__iicps__v3__0.html#ga4817f45c28341cea4ab8960dc1203acb">XIicPs_MasterRecv()</a>, <a class="el" href="group__iicps__v3__0.html#ga21bdb2f8a1f09e027aa8b0e9d6648d75">XIicPs_MasterRecvPolled()</a>, <a class="el" href="group__iicps__v3__0.html#ga3027c1eb6ece3193a978a2da8e06c011">XIicPs_MasterSend()</a>, <a class="el" href="group__iicps__v3__0.html#ga71584f1a7e675cde41cfd9d1bd4320b4">XIicPs_MasterSendPolled()</a>, <a class="el" href="group__iicps__v3__0.html#ga1169a92eb8594d6f038816b5740916f7">XIicPs_Reset()</a>, <a class="el" href="group__iicps__v3__0.html#ga6f9db7651cd6ee0232dc9fdaca3f976a">XIicPs_SelfTest()</a>, <a class="el" href="group__iicps__v3__0.html#gaec1dc5be2be8a7394263cfe56af976c5">XIicPs_SetOptions()</a>, <a class="el" href="group__iicps__v3__0.html#gafb24cfdacf6cf28d80126862dc1cfbe5">XIicPs_SetSClk()</a>, <a class="el" href="group__iicps__v3__0.html#gad1c7ffa09df93fb59f97b0a3bf5baaa7">XIicPs_SetupSlave()</a>, <a class="el" href="group__iicps__v3__0.html#ga716cdb9f63e56269824866872958dd78">XIicPs_SlaveInterruptHandler()</a>, <a class="el" href="group__iicps__v3__0.html#ga1840936a940459c5a71858f94915f933">XIicPs_SlaveRecv()</a>, <a class="el" href="group__iicps__v3__0.html#ga74b0af9e4395c8de724dc377e3504d0d">XIicPs_SlaveRecvPolled()</a>, <a class="el" href="group__iicps__v3__0.html#ga4478d1d94f349deda02c0191a7529113">XIicPs_SlaveSend()</a>, and <a class="el" href="group__iicps__v3__0.html#ga5ca49d9131b13d66f58de0b5a23faea4">XIicPs_SlaveSendPolled()</a>.</p>

</div>
</div>
<a class="anchor" id="gab1b5b0096bd5138a78be794448e6b681"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u16 XIicPs_Config::DeviceId</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Unique ID of device. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#gae97ad9c202953c7e49bfb56533c47079">XIicPs_CfgInitialize()</a>.</p>

</div>
</div>
<a class="anchor" id="gafbb42f3963d40b41b322b76c88dcd916"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XIicPs_Config::InputClockHz</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Input clock frequency. </p>

<p>Referenced by <a class="el" href="group__iicps__v3__0.html#gae97ad9c202953c7e49bfb56533c47079">XIicPs_CfgInitialize()</a>, <a class="el" href="group__iicps__v3__0.html#ga9f2d2d3d11c2c9125a5bc8a0d95593cb">XIicPs_GetSClk()</a>, and <a class="el" href="group__iicps__v3__0.html#gafb24cfdacf6cf28d80126862dc1cfbe5">XIicPs_SetSClk()</a>.</p>

</div>
</div>
<a class="anchor" id="ga11a983ef1b7318339618ff352e81bb2e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_iic_ps___config.html">XIicPs_Config</a> XIicPs_ConfigTable[XPAR_XIICPS_NUM_INSTANCES]</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__sinit_8c.html">xiicps_sinit.c</a>&gt;</code></p>

<p>This table contains configuration information for each IIC device in the system. </p>

</div>
</div>
<a class="anchor" id="ga11a983ef1b7318339618ff352e81bb2e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_iic_ps___config.html">XIicPs_Config</a> XIicPs_ConfigTable[XPAR_XIICPS_NUM_INSTANCES]</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xiicps__g_8c.html">xiicps_g.c</a>&gt;</code></p>
<b>Initial value:</b><div class="fragment"><div class="line">= {</div>
<div class="line">        {</div>
<div class="line">                 (u16)XPAR_XIICPS_0_DEVICE_ID, </div>
<div class="line">                 (u32)XPAR_XIICPS_0_BASEADDR,  </div>
<div class="line">                 (u32)XPAR_XIICPS_0_I2C_CLK_FREQ_HZ  </div>
<div class="line">        },</div>
<div class="line"></div>
<div class="line"></div>
<div class="line"></div>
<div class="line"></div>
<div class="line"></div>
<div class="line"></div>
<div class="line"></div>
<div class="line">}</div>
</div><!-- fragment -->
<p>This table contains configuration information for each IIC device in the system. </p>

</div>
</div>
</div><!-- contents -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
